Migrate to pyproject.toml #554
Conversation
pyproject.toml
Outdated
| name = "seedsigner" | ||
| readme = "README.md" | ||
| requires-python = ">=3.10" | ||
| version = "0.7.0" |
There was a problem hiding this comment.
I realize this was previously in setup.py, but I wonder if there's any way to mitigate the minor housekeeping required to keep this in sync with releases.
Can version just be omitted? We're not going to be releasing this as a pip package so specifying version here seems pointless (unless required by spec).
There was a problem hiding this comment.
Rebased the PR so that the version in the pyproject.toml file is now 0.8.0-rc1 like on the current dev branch.
Removing the version entirely is not possible as it results in the error configuration error: `project` must contain ['version'] properties` when pip installing or creating a sdist via `python -b build ..
Another option would to calculate the version dynamically based on repo tags via setuptools-scm... maybe something for another PR, as it is a logical change and not just moving config settings into the pyproject.toml.
|
ACK! I can confirm that everything ran as expected: pytest
coverage run -m pytest
coverage report
coverage html |
|
ACK |
Description
Move towards a more modernised tool-agnostic Python package setup: Migrate .coveragerc, MANIFEST.in, pytest.ini, setup.py to one single pyproject.toml to have less boilerplate files in the repo root.
This is not so much relevant for the use on the image as there only the src folder is kept from the repo and every other file is ignored / removed see e.g. https://github.com/SeedSigner/seedsigner/blob/dev/.github/workflows/build.yml#L76
So the pyproject.toml is both an informal place containing all the Python tooling specific package information and is currently only used when installing the package during testing via pip. Both coverage (since version 5.0, we use 7.3.1) and pytest (since version 6.0, we use 7.4.2) support reading their configuration from the central pyproject.toml.
The formal spec can be found here https://packaging.python.org/en/latest/specifications/pyproject-toml/#pyproject-toml-spec
This pull request is categorized as a:
Checklist
pytestand made sure all unit tests pass before sumbitting the PRIf you modified or added functionality/workflow, did you add new unit tests?
I have tested this PR on the following platforms/os:
Note: Keep your changes limited in scope; if you uncover other issues or improvements along the way, ideally submit those as a separate PR. The more complicated the PR the harder to review, test, and merge.