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

Update to use pyproject.toml for packaging metadata #137

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

davidwilby
Copy link
Collaborator

📝 Description

At the moment, dependencies are specified in both setup.cfg and in requirements files under requirements/ which is a little odd and opens up potential errors such as in #131 where I bumped the version of neuralprocesses in the requirements file but not in the setup.cfg - the tests pass because they use the requirements file, but the built package would not have the same dependency version specification.

In this PR, I suggest moving to using pyproject.toml for specifying package metadata. This does solve the above problem, though that could also be solved using setup.cfg, but the python community seems to be converging on pyproject.toml. If we need to keep setup.py for any reason, that is also possible.

This PR also updates the workflows and docs accordingly.

I've tested that builds succeed and all seems to work as expected.

Feel free to close this @tom-andersson if it isn't to your taste.

✅ Checklist before requesting a review

(See the contributing guide for more details on these steps.)

  • I have installed developer dependencies with pip install -r requirements/requirements.dev.txt and running pre-commit install (or alternatively, manually running ruff format before commiting)

If changing or adding source code:

  • tests are included and are passing (run pytest).
  • documentation is included or updated as relevant, including docstrings.

If changing or adding documentation:

  • docs build successfully (jupyter-book build docs --all) and the changes look good from a manual inspection of the HTML in docs/_build/html/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant