napari / cookiecutter-napari-plugin

Cookiecutter for napari plugins
BSD 3-Clause "New" or "Revised" License
67 stars 39 forks source link

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

Closed GenevieveBuckley closed 3 months ago

GenevieveBuckley commented 10 months ago

Closes https://github.com/napari/cookiecutter-napari-plugin/issues/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 commented 6 months ago

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

GenevieveBuckley commented 3 months ago

This is ready for review