-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📦️(project) improve dependencies management #218
Conversation
a3d7cf7
to
e54e5a4
Compare
284d9b6
to
440908b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
However when renovate bot updates dependencies every week, we have to be aware not to forget that backend, lrs and cli dependencies have to be updated in the Changelog 😉
440908b
to
c7d9937
Compare
Ready for a new review! 🙏 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! One tiny remark
Ralph can be used as a CLI, as a server, or as a library. To handle this complexity, we decided to split dependencies to core and extra requirements: - the core package only contains dependencies to use Ralph as a library (mostly to use models in a python project), - the `cli` extra installs Click-related dependencies, - the `backends` extra installs all supported backends; it might also correspond to a library usage, - the `lrs` extra installs FastAPI-related dependencies for the LRS server implementation. A full installation command would look like: ``` pip install ralph-malph[backends,cli,lrs] ``` While a library installation could be: ``` pip install ralph-malph ``` or ``` pip install ralph-malph[backends] ```
cf8882f
to
c0a31ff
Compare
Purpose
Ralph can be used as a CLI, as a server, or as a library. To handle this complexity, we need to split dependencies.
Proposal
We decided to split dependencies to core and extra requirements:
cli
extra installs Click-related dependencies,backends
extra installs all supported backends; it might also correspond to a library usage,lrs
extra installs FastAPI-related dependencies for the LRS server implementation.A full installation command would look like:
While a library installation could be:
or
Depends on #217 for the Tray testing in the CI.