Skip to content
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

Split requirements.txt to separate files for clients/development/docs/agents #167

Closed
wants to merge 6 commits into from

Conversation

BrianJKoopman
Copy link
Member

@BrianJKoopman BrianJKoopman commented Sep 11, 2020

Description

This splits out the requirements file so users can install a minimal amount of packages just required for running ocs clients, while optionally being able to install all packages needed for development, etc.

I've updated the documentation to describe the separate requirements files. We default to clients and docs dependencies. Individual agents are now managing their own dependencies, so those will be installed only in the specific Agent containers. Lastly there's the dev.txt file, which includes pytest. We use that in the Dockerfile for building ocs images since we run the tests in the CI pipeline. This could be split out if desired, but I'm not sure it's worth doing.

Other notes:

  • Removed ipywidgets requirement by also removing old ocs_widgets.py module.
  • Removed msgpack, as it didn't seem to be used in anything -- please correct me if I'm wrong (it does seem to get pulled in by some other packages, but maybe we don't need to explicitly install it)

Motivation and Context

Closes #92

How Has This Been Tested?

I'm working on testing this. Tests pass so far though.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • Unless I am preparing a release, I have opened this PR onto the develop branch.

@BrianJKoopman BrianJKoopman added the cleanup Cleanup that of old code or documentation label Sep 14, 2020
@BrianJKoopman BrianJKoopman changed the title Requirements prune Split requirements.txt to separate files for clients/development/docs/agents Sep 14, 2020
@BrianJKoopman
Copy link
Member Author

Many of the changes in the works here have happened gradually over several PRs.

Given that progress, I don't think we'll be reducing the number of packages much further from here. So I will consider #92 resolved and also close this draft PR.

@BrianJKoopman BrianJKoopman deleted the requirements-prune branch December 2, 2021 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Cleanup that of old code or documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lots of required packages
1 participant