[kbn-evals] Examples should not ship in the installed wheel

Open Beginner friendly
#40 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Quiet
Tech stack
python

Research direction

Start with pyproject.toml lines 37-47 to inspect the wheel package list and elastic_evals.suites entry points. Verify a clean pip or uv install contains no examples, confirm elastic-evals list shows no pre-registered suites, and document the plugin entry-point contract with a short example.

Written by the indexing model from the issue text.

Description

kbn-evals Team:nightshift-context-and-research
Summary

pyproject.toml includes examples/ in the wheel and pre-registers all three demo suites as entry-point plugins. Every pip install elastic-evals ships demo code to the user and shows three suites they didn't create in elastic-evals list.

Problem
  • pyproject.toml:46-47: examples listed in wheel packages
  • pyproject.toml:37-40: three example suites registered as elastic_evals.suites entry points
  • examples as a top-level module name can collide with other packages
  • The three entry-point IDs use inconsistent naming patterns within kebab-case (agent-builder, claude-code-eval, chatbot-rag-eval-example)
Fix
  • Remove examples from the wheel packages list
  • Remove example entry-point registrations
  • Document the plugin entry-point contract so users can register their own suites
Done when
  • pip or uv installs no example code
  • elastic-evals list on a clean install shows no pre-registered suites
  • The plugin contract is documented with a short example
Dominant language
Python
Stars
2
Forks
0
Avg merge
1d 5h
Merged PRs (30d)
17

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elastic/elastic-evals-sdk-python

All issues in elastic/elastic-evals-sdk-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.