Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,12 @@ if __name__ == "__main__":
Run it with `python hello.py --name Ada`. The full lifecycle and configuration
options are documented below.

For a complete maintained example, see the independent
[`base-cli-demo`](https://github.com/basefoundry/base-cli-demo) reference
consumer. It is versioned separately (`0.1.0`) and currently tests the released
`base-cli>=0.4.3,<0.5` line; its 0.5.0 upgrade is tracked in
[base-cli-demo#47](https://github.com/basefoundry/base-cli-demo/issues/47).

Release builds, TestPyPI rehearsals, and protected PyPI publication are
documented in [`docs/releasing.md`](https://basefoundry.github.io/base-cli/releasing/). The package exposes
`base_cli.__version__`, which matches the distribution version.
Expand Down
15 changes: 13 additions & 2 deletions docs/adoption-evidence.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,23 @@ written permission from that team.
| Category | What it proves | Source | Public claim allowed |
| --- | --- | --- | --- |
| Reference fixture | A maintained consumer shape remains compatible | [`compatibility/README.md`](https://github.com/basefoundry/base-cli/blob/main/compatibility/README.md) and CI | “The fixture passed.” |
| Maintained reference/learning consumer | A complete external repository exercises the public consumer boundary | [`base-cli-demo`](https://github.com/basefoundry/base-cli-demo) and its dated CI | “The demo passed its declared framework line.” It is not an adopter claim. |
| Compatibility run | A specific revision/version passed a dated matrix | `base-cli-compatibility-evidence-<run-id>` artifact | “Version X passed run Y.” |
| External adopter | A real independent team completed an agreed outcome | Permissioned adopter record | Only the approved case-study facts |

Reference fixtures must remain separate packages with their own metadata and
tests. Base, base-demo, and other adjacent repositories are explicitly
excluded from the independent-adopter count.
tests. Base, base-demo, `base-cli-demo`, and other adjacent repositories are
explicitly excluded from the independent-adopter count.

`base-cli-demo` is a maintained reference and learning consumer, versioned
independently (`0.1.0`). Its CI demonstrates that a real consumer can exercise
the public facade, lifecycle, output, error, and optional-integration paths for
the exact framework dependency line it declares; it is not an independent
adopter result or a substitute for a dated compatibility-fixture artifact.
While its current released line is `base-cli>=0.4.3,<0.5`, the 0.5.0 upgrade is
tracked in [base-cli-demo#47](https://github.com/basefoundry/base-cli-demo/issues/47)
and must be green against the published framework before being described as
0.5.0 evidence.

## Adopter program

Expand Down
6 changes: 6 additions & 0 deletions docs/consumer-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ command, one option, and the `run_app()` process boundary. It is suitable for
a temporary consumer project and does not require Typer, Rich, YAML, or any
private repository layout.

For a maintained, runnable consumer with nested commands, structured errors,
and optional Typer, Rich, and OpenTelemetry scenarios, continue to
[`base-cli-demo`](https://github.com/basefoundry/base-cli-demo). The demo is
reference/learning evidence rather than an independent adopter, and it is
versioned separately from the framework.

## Install and create the command

Use an isolated virtual environment when trying the recipe. Activate it using
Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,5 +93,9 @@ Continue with the framework guides:
compatibility policy.
- [Reference applications](https://github.com/basefoundry/base-cli/tree/main/examples)
for complete consumer patterns.
- [`base-cli-demo`](https://github.com/basefoundry/base-cli-demo) for the
maintained end-to-end reference consumer, optional integration scenarios,
and runnable documentation examples. It is versioned independently and its
current released dependency line is `base-cli>=0.4.3,<0.5`.
- [Installation and packaging](adopter-readiness.md) for dependency extras,
distribution checks, and release guidance.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ nav:
- Getting started:
- Framework choice: framework-choice.md
- Consumer quickstart: consumer-quickstart.md
- Reference consumer: https://github.com/basefoundry/base-cli-demo
- Adopter readiness: adopter-readiness.md
- Adoption evidence: adoption-evidence.md
- Compatibility dashboard: compatibility-dashboard.md
Expand Down
Loading