search

NLeSC / guide

Software Development Guide
https://guide.esciencecenter.nl
Creative Commons Attribution 4.0 International
47 stars 30 forks source link

Update Python Packaging section to use `pyproject.toml` instead of `setup.cfg` #326

Closed sjvrijn closed 3 months ago

sjvrijn commented 9 months ago

Currently, the Making an installable package section of the Python guide still refers to setup.cfg as the main of two required files.

Since we've also moved away from setup.cfg in our python cookiecutter template, I think we should update the guide to match what we've currently implemented as best practice?

egpbos commented 9 months ago

In theory (and in practice, see e.g. https://github.com/NLeSC/python-template/issues/328), we could also rewrite the setuptools parts a bit to make people aware of alternatives that we started using, i.e. hatch/hatchling.

bouweandela commented 9 months ago

Maybe we could replace that whole section by one or more links to tutorials/documentation pages? The topic is quite generic, so I would expect that good resources are available, and the current text is rather detailed and therefore likely to go out of date quickly.

egpbos commented 9 months ago

Sounds good to me.

ofek commented 7 months ago

Let me know if I can help with reviews (I maintain Hatch/Hatchling)!

egpbos commented 5 months ago

@sjvrijn Do you want to make a PR for this? :)