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

[Feature request]: Convert Gempyor's setup.cfg to pyproject.toml #314

Closed
TimothyWillard opened this issue Sep 17, 2024 · 0 comments · Fixed by #391
Closed

[Feature request]: Convert Gempyor's setup.cfg to pyproject.toml #314

TimothyWillard opened this issue Sep 17, 2024 · 0 comments · Fixed by #391
Labels
dependency For issues with package dependencies. enhancement Request for improvement or addition of new feature(s). gempyor Concerns the Python core. low priority Low priority. quick issue Short or easy fix.

Comments

@TimothyWillard
Copy link
Contributor

Label

enhancement, gempyor, quick issue

Priority Label

low priority

Is your feature request related to a problem? Please describe.

While setup.cfg is still supported (and likely will always be supported for python packaging) the recommended approach these days is to use a pyproject.toml metadata file to describe a package and it's dependencies. Looks like there is already a preliminary pyproject.toml file but it is very empty.

Is your feature request related to a new application, scenario round, pathogen? Please describe.

n/a

Describe the solution you'd like

Move the gempyor package description into pyproject.toml. The following guides are reputable and detailed:

  1. https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
  2. https://packaging.python.org/en/latest/guides/modernize-setup-py-project/

Also many modern tools like uv have the ability to help generate the config and resolve dependencies from a friendly CLI, which should help make this a quick issue.

@github-actions github-actions bot added enhancement Request for improvement or addition of new feature(s). gempyor Concerns the Python core. low priority Low priority. meta/workflow Relating to CI / issue templates / testing frameworks / etc. quick issue Short or easy fix. labels Sep 17, 2024
@TimothyWillard TimothyWillard removed the meta/workflow Relating to CI / issue templates / testing frameworks / etc. label Sep 17, 2024
@TimothyWillard TimothyWillard added the dependency For issues with package dependencies. label Nov 7, 2024
TimothyWillard added a commit that referenced this issue Nov 8, 2024
Updated to the more modern `pyproject.toml` format per GH-314. Edit
`venv` in `.gitignore` to be a bit more generic for developer ease.
@TimothyWillard TimothyWillard linked a pull request Nov 8, 2024 that will close this issue
TimothyWillard added a commit that referenced this issue Nov 8, 2024
Updated to the more modern `pyproject.toml` format per GH-314. Edit
`venv` in `.gitignore` to be a bit more generic for developer ease.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependency For issues with package dependencies. enhancement Request for improvement or addition of new feature(s). gempyor Concerns the Python core. low priority Low priority. quick issue Short or easy fix.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant