modernize build infrastructure #4
Merged
Conversation
This file contains 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
This is the "src-layout" directory structure expected by setuptools, which helps automate discovery and packaging https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#automatic-discovery
This is strongly deprecated, see https://packaging.python.org/en/latest/discussions/setup-py-deprecated/#:~:text=However,run%20anymore so we use the `build` module instead. Also adds a basic pyproject.toml to explicitly list build dependencies.
Use standard config format instead of (setuptools-specific) Python code; eliminate code to manually read README and requirements.txt files
`provides` and `zip_safe` are ignored/deprecated, see https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#setuptools-specific-configuration `pytest` and `numpydoc` aren’t actually used; seem to be copy & paste artefacts from snewpy
Without this, *.h files are not automatically included in the sdist, so building from the sdist (e.g. using `python -m build`) fails
JostMigenda
force-pushed
the
JostMigenda/modernBuild
branch
from
aaa295c to
22d78d1
Compare
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.
Python packaging documentation explicitly warns that commands like
python setup.py sdist bdist_wheelare deprecated and “MUST NOT be run anymore”.The recommended replacement is the
buildmodule. This also ensures more reproducible builds by requiring build dependencies to be explicitly declared (in apyproject.tomlfile) and building the project in an isolated virtual environment.This PR updates the build infrastructure accordingly. It also moves all package metadata to the
pyproject.tomlfile and leavessetup.pyto focus solely on the code needed to build the binary extension.(This is laying the groundwork for #3, which will be in a separate PR for clarity.)