Refactor CLI dependencies and update documentation - #17
Merged
Conversation
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
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.
This pull request introduces a breaking change for CLI users by moving the
typerandrichdependencies out of the main runtime requirements and into a newcliextra. This change allows projects that only import the library to avoid unnecessary dependency constraints, particularly onrich, 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:
typerandrichfrom the core runtime dependencies inpyproject.tomlto a new optionalcliextra, preventing them from being installed unless explicitly requested. This resolves dependency conflicts for consumers that do not use the CLI.cliextra, ensuring the container image continues to provide the CLI functionality.clidependencies to the development requirements inpyproject.tomlso that CLI tests still run in development environments.Documentation updates:
README.mdto clarify that the CLI now requires installation with thecliextra and to explain the motivation behind the change. [1] [2]