guide icon indicating copy to clipboard operation
guide copied to clipboard

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

Open sjvrijn opened this issue 1 year ago • 5 comments

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?

sjvrijn avatar Feb 19 '24 16:02 sjvrijn

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.

egpbos avatar Feb 19 '24 16:02 egpbos

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.

bouweandela avatar Feb 19 '24 19:02 bouweandela

Sounds good to me.

egpbos avatar Feb 19 '24 19:02 egpbos

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

ofek avatar Apr 22 '24 01:04 ofek

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

egpbos avatar Jun 19 '24 08:06 egpbos