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

move build configuration from setup.cfg to pyproject.toml #30

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

zacharyburnett
Copy link

setuptools now supports the [project] table for project metadata, defined by PEP621.

Additionally, setuptools now supports its own entry in pyproject.toml called [tool.setuptools] (pypa/setuptools#1688, https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#setuptools-specific-configuration); however, it comes with the following disclaimer:

Support for declaring configurations not standardized by PEP 621 (i.e. the [tool.setuptools] table), is still in beta stage and might change in future releases.

Reading toml is supported natively in Python 3.11 with tomllib. Given this, we can consolidate the build configuration into a single pyproject.toml file that can possibly be read by other build systems in the future.

@pllim
Copy link
Collaborator

pllim commented Apr 24, 2023

Are we reviving STScI package template? I don't think it is being maintained anymore.

https://github.com/OpenAstronomy/packaging-guide

@zacharyburnett
Copy link
Author

Are we reviving STScI package template? I don't think it is being maintained anymore.

https://github.com/OpenAstronomy/packaging-guide

ah ok, I followed a reference from the INS guide so I assumed it was still current

@pllim
Copy link
Collaborator

pllim commented Apr 24, 2023

Hmm even https://github.com/spacetelescope/ins-jwst-community-software has not been touched for a year. 🤷

@zacharyburnett zacharyburnett deleted the pep621 branch April 25, 2023 14:59
@zacharyburnett zacharyburnett restored the pep621 branch April 28, 2023 15:37
@zacharyburnett
Copy link
Author

zacharyburnett commented Apr 28, 2023

I made an analogous PR to OpenAstronomy/packaging-guide#38; I'll keep this branch alive until we figure out if anyone is actually using this repo, and then if not we should probably archive it / indicate deprecation

@zacharyburnett
Copy link
Author

ins-jwst-community-software now includes references to requiring pyproject.toml instead of setup.cfg: https://github.com/spacetelescope/ins-jwst-community-software/blob/db8c2e2ace4dca74304497191bc4e3a4a71e0745/tier1_standards/package_structure.md#useful-links

I will reopen this PR and make sure it is up-to-date

@zacharyburnett zacharyburnett reopened this Jan 8, 2024
@zacharyburnett zacharyburnett marked this pull request as ready for review January 8, 2024 19:56
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.

2 participants