DM-27354: Enable pip installation using pyproject.toml / PEP 517 #30
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
- Removed license field because it's not recommended when there is a license classifier. - Moved long_description to setup.cfg, removing that logic from setup.py - Formatting consistency
tests_require is deprecated, so instead we've created a "test" extra.
This is for consistency with the original requirements.txt file.
setuptools_cpp doesn't offer any obvious functionality over pybind11's built-in setuptools integration, so we'll use the pybind11 recipe. Based on: https://github.com/pybind/python_example/blob/master/setup.py Also package headers with MANIFEST.in This appears necessary for a pip installation when building the pybind11 extension.
pyroject.toml and PEP 517 is really the only way to ensure that certain python dependencies are present *before* a package is built. This replaces the setup_requires section in setup.cfg (it didn't install build dependencies in time) and requirements.txt (it's not a viable solution for installing dependencies for a library). Update GitHub Actions to use this installation method.
timj
approved these changes
Nov 3, 2020
| @@ -45,8 +39,6 @@ | |||
|
|
|||
| setup( | |||
| version=version, | |||
| long_description=long_description, | |||
There was a problem hiding this comment.
is long_description no longer something that is used then? I thought it was how you got the readme onto the PyPI page?
There was a problem hiding this comment.
@timj This is handled by the file: directive in the setup.cfg file for code-less import of the README into the package metadata.
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.
This PR makes sphgeom pip installable by downstream packages without requiring a requirements.txt file to pre-populate the environment. The solution here relies on the pyproject.toml file to ensure that build dependencies are installed before setuptools is called to build and install the package. This relies on the new-ish PEP 517 mechanism for specifying the build requirements.
This work also removes the extra
setuptools_cppdependency as it didn't seem to add any value compared to pybind11's built-in setuptools integration.