Convert setup.cfg to pyproject.toml
#260
Conversation
requirements/build.txt
Outdated
There was a problem hiding this comment.
We have previously been installing dependencies using the files in requirements/ when running tests and building docs. The problem with this approach is that the requirements were defined in two places, which meant that we might remember to update a dependency in one place but forget to do it in another. We can get by without the requirements files by making use of the dependency sets (e.g., docs and tests) now being defined in pyproject.toml.
pyproject.toml
Outdated
| dependencies = [ | ||
| "astropy >= 5.1", | ||
| "cached-property >= 1.5.2", | ||
| "matplotlib >= 3.5.0", | ||
| "numpy >= 1.24.0", | ||
| "requests >= 2.28.0", | ||
| "scikit-image >= 0.19.0", | ||
| "scipy >= 1.8.0", | ||
| "sunpy[map] >= 4.0.0", | ||
| ] |
There was a problem hiding this comment.
I updated the dependencies here to be a bit more consistent with SPEC 0 (i.e., having the minimum required versions of dependencies be ∼24 months old).
| dev = [ | ||
| "nox >= 2022.8.7", | ||
| "pre-commit >= 3.6.0", | ||
| ] |
There was a problem hiding this comment.
The dev dependency set includes packages that we need for both tests & docs.
| tests = [ | ||
| "pytest >= 8.0.0", | ||
| "pytest-allclose >= 1.0.0", | ||
| "pytest-xdist >= 3.6.1", | ||
| ] |
There was a problem hiding this comment.
We can install xrtpy & packages necessary for running tests with pip install .[dev,tests] (from the top-level directory of the repo).
Similarly, we can do pip install .[dev,docs] for building docs. This is now handled by the Nox sessions.
| session.install("-r", "requirements/tests.txt") | ||
| session.install(".") | ||
| session.install(".[dev,tests]") |
There was a problem hiding this comment.
The changes like these allow us to bypass the need for having the requirements files specified in the requirements/ directory. We'll be installing the dependencies for running tests based on the dependency sets in pyproject.toml instead, so dependencies will only need to be included in one place.
| description = "For analyzing data from the X-Ray Telescope (XRT) on the Hinode spacecraft." | ||
| license = {file = "LICENSE"} | ||
| classifiers = [ | ||
| "Development Status :: 4 - Beta", |
There was a problem hiding this comment.
I changed this from 3 - Alpha to 3 - Beta since XRTpy has been gaining maturity.
| # SPEC 0 recommends that packages in the scientific pythoniverse support | ||
| # versions of Python that have been released in the last ≤36 months | ||
| requires-python = ">=3.9" |
There was a problem hiding this comment.
Here's the link to SPEC 0. We could drop Python 3.9 anytime.
This PR makes improvements to XRTpy packaging that I've been meaning to do for a while now. It makes the following changes:
setup.cfgandsetup.pyin favor ofpyproject.toml. For more details, check out the page on how to moderize a setup.py based project.pyproject.toml. In addition to the dependencies needed for building and installing XRTpy, there are nowdocs,tests, anddevdependencies.requirements/since they are redundant and no longer needed for running tests and building docs.