Skip to content

Refactor CLI dependencies and update documentation - #17

Merged
sebdraven merged 3 commits into
masterfrom
release/3.1.0
Aug 4, 2026
Merged

Refactor CLI dependencies and update documentation#17
sebdraven merged 3 commits into
masterfrom
release/3.1.0

Conversation

@sebdraven

Copy link
Copy Markdown
Collaborator

This pull request introduces a breaking change for CLI users by moving the typer and rich dependencies out of the main runtime requirements and into a new cli extra. This change allows projects that only import the library to avoid unnecessary dependency constraints, particularly on rich, which previously caused conflicts with other packages. The Dockerfile and documentation have been updated to reflect this new installation method, and the development requirements now explicitly include the CLI dependencies to ensure tests continue to work.

Dependency management and installation changes:

  • Moved typer and rich from the core runtime dependencies in pyproject.toml to a new optional cli extra, preventing them from being installed unless explicitly requested. This resolves dependency conflicts for consumers that do not use the CLI.
  • Updated the Dockerfile to install the cli extra, ensuring the container image continues to provide the CLI functionality.
  • Added the cli dependencies to the development requirements in pyproject.toml so that CLI tests still run in development environments.

Documentation updates:

  • Updated the README.md to clarify that the CLI now requires installation with the cli extra and to explain the motivation behind the change. [1] [2]
  • Added a detailed changelog entry describing the breaking change, new installation instructions for the CLI, and the rationale for the update.

@sebdraven
sebdraven merged commit d8bd2b9 into master Aug 4, 2026
11 checks passed
@sebdraven
sebdraven deleted the release/3.1.0 branch August 4, 2026 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant