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

Aperta Adatta ai principianti
#40 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
76/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
build-system, cli, documentation

Direzione di ricerca

Inizia dalle righe 37-47 di pyproject.toml per ispezionare l’elenco dei pacchetti del wheel e gli entry point di elastic_evals.suites. Verifica che un’installazione pulita con pip o uv non contenga esempi, conferma che elastic-evals list non mostri suite pre-registrate e documenta il contratto dell’entry point con un breve esempio.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
Python
Stelle
2
Fork
0
Merge medio
1g 5h
PR unite (30g)
17

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di elastic/elastic-evals-sdk-python

Tutte le issue di elastic/elastic-evals-sdk-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.