docs(readme): Quick start runnable en tête (npm + PyPI)#151
Merged
Conversation
- README npm (packages/core/README.md) : bloc Quick start avec exemple TSX <bpm.metric> (signature React riche, currency="EUR"). - README PyPI (README.md racine) : bloc Quick start avec signature Python vérifiée bpm.metric(label, value, delta) — pas de currency, miroir de la surface React. README uniquement, aucun code/dérivé/version touché. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TndQ8ZWUFipaLRyziiP4tj
remigit55
marked this pull request as ready for review
June 17, 2026 10:09
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Objectif
Un dev ou un agent qui rencontre le package doit avoir un exemple copiable qui tourne, en tête de README. Absent jusqu'ici.
Changements (README uniquement)
packages/core/README.md) — bloc## Quick startinséré juste après l'intro, avant## Installation. Exemple TSX<bpm.metric>avec la signature React riche (currency="EUR").README.mdracine, référencé parpyproject.toml→readme) — bloc## Quick startinséré après l'intro, avant## Vivant. Signature Python vérifiéebpm.metric(label, value, delta)— pas decurrency/valueLocale/deltaType(surface Python plus pauvre que React, parité respectée).Parité vérifiée
get_component bpm.metric(MCP).0.1.54(inspect.signature→metric(label, value, delta=None, *, name=None)).Périmètre
Diff limité à 2 fichiers, 35 insertions, 0 suppression. Aucun code, composant,
bpm/__init__.py, dérivé généré (llms.txt,versions.json) ni version touché.Validation attendue (après merge)
@blueprint-modular/core.pip install blueprint-modular && python3 -c "import bpm; bpm.metric(label='x', value=1, delta='+1%')"ne lève pas d'erreur.🤖 Generated with Claude Code
https://claude.ai/code/session_01TndQ8ZWUFipaLRyziiP4tj
Generated by Claude Code