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

Packaging: remove setup.cfg, move info into pyproject.toml #171

Merged

Conversation

GenevieveBuckley
Copy link
Contributor

@GenevieveBuckley GenevieveBuckley commented Nov 3, 2023

Closes #167

Now that pyproject.toml supports project metadata (classifiers, author info, etc.) we should remove the setup.cfg file and put the information into pyproject.toml

Advantages:

  • simplifies the repository

  • It makes it much easier for users to retro-fit napari plugins to existing

  • it discourages people from accidentally duplicating info across both pyproject.toml and setup.cfg (if this happens pyproject.toml overwrites the information).

    For an in the wild example of this problem, Draga and I got an email from some users confused about why their plugin was not being picked up by the napari hub. It turned out that they had classifier tags in both pyproject.toml AND setup..cfg, and so the napari framework tag was not being included in the packaged build (and therefore not available on PyPI for the napari-hub to discover it)

@Czaki
Copy link
Contributor

Czaki commented Feb 22, 2024

Did you need help with debug, or just do not have time?

@GenevieveBuckley
Copy link
Contributor Author

This is ready for review

Copy link
Contributor

@Czaki Czaki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As we dropped python 3.9 already, we may want to not suggest python 3.8 compatibility for plugins.

{{cookiecutter.plugin_name}}/tox.ini Outdated Show resolved Hide resolved
{{cookiecutter.plugin_name}}/tox.ini Outdated Show resolved Hide resolved
tox.ini Outdated Show resolved Hide resolved
{{cookiecutter.plugin_name}}/pyproject.toml Outdated Show resolved Hide resolved
{{cookiecutter.plugin_name}}/pyproject.toml Outdated Show resolved Hide resolved
GenevieveBuckley and others added 5 commits May 13, 2024 10:31
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
@Czaki Czaki added the ready to merge Ready to be merged, 24 hr clock label May 13, 2024
@GenevieveBuckley GenevieveBuckley merged commit 04ec78f into napari:main May 16, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready to merge Ready to be merged, 24 hr clock
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Packaging: remove setup.cfg and move info into pyproject.toml
2 participants