refactor(packaging): centralise dependency metadata in pyproject - #32
Open
ackl wants to merge 1 commit into
Open
refactor(packaging): centralise dependency metadata in pyproject#32ackl wants to merge 1 commit into
ackl wants to merge 1 commit into
Conversation
* move documentation and development dependencies into optional extras so pyproject.toml remains the canonical source and version constraints cannot drift * reduce requirements.txt and environment.yml to compatibility entry points that preserve existing pip or conda workflows * consolidate INSTALL.md and docs/installation.md through a MyST include * update documentation to reflect actual status
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.
Hi Robert,
I noticed that there was some redundancy between
environment.ymlrequirements.txtandpyproject.toml, it's possible to just specify everything inpyproject.tomland use that as the source of truth. this way theres less risk of dep versions drifting accidentally if the project updates them in the future.pip install -r requirements.txtorpip install .orconda env create -f environment.ymlall still work exactly as they did before.MyST has a feature to include files from outside the doc directory, so i've linked
docs/installation.mdtoINSTALL.md, this way there isn't two seprate doc files to maintain for install instructions.I've also updated the install docs to include some instructions for
uvwhich is a quite a nice python package and env manager.Also the install docs said that nf2 was available to install via conda on the conda-forge channel but it doesn't actually seem to be published?
Please have a look through this PR when you get a chance