Add optional subgroups to pyproject.toml
#699
Merged
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.
Description
This PR does three things:
pyproject.toml
to manage all optional subgroups (egtorch
,dev
etc)requirements
subdirectory which had caused a lot of confusion and replaces it with a simpler configuration inside.github
.More Details
Rather than having a separate bunch of files in a
requirements
subdirectory for managing our dependencies, we now manage everything viapyproject.toml
. This is the modern way of doing Python packaging, and is arguably a lot simpler than having a separaterequirements
subdirectory. A minor disadvantage is that it does make ourpyproject.toml
quite large and a bit harder to read. In the future, adding depedencies is simply a matter of adding to the appropriate subgroup inpyproject.toml
, or creating a new subgroup if this is necessary. Users can install these subgroups by doing apip install superduperdb[my_subgroup_name]
.The original intention for having a separate
requirements
subdirectory was i) to make ourpyproject.toml
more readable and ii) so that we could pin our dependencies for CI. We have sacrificed i) for the sake of simplicity (see 1.). For ii), I have now moved these files inside the.github
subdirectory, as they are only used for CI and do not need to be visible in the root directory. I have also reduced the number of files to 2 -dev
anddocs
. This will mean that our CI will take a bit longer, but it's a lot simpler to understand and maintain. Further details are insideCONTRIBUTING.md
Since we now only have
dev
anddocs
requirements files, I have merged the CI into a single step, where linting, type-checking and testing all happen togetherRelated Issues
#653
#627
Checklist
make test
successfully?Additional Notes or Comments