move setup.cfg to pyproject.toml

[sjvrijn]

Description

• Removed setup.py and setup.cfg
• Added all relevant info to pyproject.toml

Some minor adjustments made during the translation:

• Added the requirement >=64.0.0 to setuptools under [build-system]: this is the first version to add support for PEP660: Editable installs for pyproject.toml based builds
• Remove obsolete zip_safe setting
• Simplified package data to just include-package-data = true under [tool.setuptools] in combination with requiring setuptools-scm. This automatically adds all data files that are included under source control.
• Replaced package find options with an explicit packages = {{ cookiecutter.package_name }} under [tools.setuptools]
• Added an additional cookiecutter variable repository_url to define an https github url under [project.urls], since it wouldn't accept the git url in cookiecutter.repository:

ValueError: invalid pyproject.toml config: `project.urls.Repository`.
      configuration error: `project.urls.Repository` must be url

Related issues:

• Use pyproject.toml only for installing the generated package #351

Instructions to review the pull request

Create a python-template-test repo on GitHub (will be overwritten if existing)

cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
cookiecutter -c pyproject-toml-351 https://github.com/NLeSC/python-template
# Fill with python-template-test info
cd python-template-test
git init
git add --all
git commit -m "First commit"
git remote add origin https://github.com/<you>/python-template-test
git push -u origin main -f
python -m venv env
source env/bin/activate
python -m pip install --upgrade pip setuptools
python -m pip install '.[dev,publishing]'

[gcroci2]

Much cleaner now, great :) I inserted few minor suggestions, and I would only reorder the sections a bit (e.g., [tool.setuptools.packages.find] should go under [tool.setuptools] section).

[gcroci2]

In my project I have build package as well in the publishing extra. Should be needed, right?

[egpbos]

It's not yet needed, since we still depend on the old build methods. See #318 and #328 for two ways to move forward on this. Needs a separate PR by someone brave enough to make a choice ;)

[egpbos]

After reading up on setuptools package discovery and data file inclusion (check especially the comment in the pyproject.toml example) I think this whole section could be removed. For sure include-package-data = true can be removed, because it is now true by default. The package discovery could be removed if we move to a src-based layout.

This actually has two advantages:

1. This above, i.e. simpler configuration.
2. It also automatically supports single-file packages (you don't need a folder for a package if it only consists of one file, but to support that you normally need to reconfigure, see e.g. how I did that in kwandl; I think that with a src dir, though, that will also just be autodiscovered, yay!).

Suggested change

	[tool.setuptools]
	include-package-data = true
	packages = ["{{ cookiecutter.package_name }}"]

To be clear, this suggestion would have to be accompanied by adding a src dir.

[gcroci2]

I also agree that moving to a src-based layout would be the nicest way to go :)

[egpbos]

This is a great PR, thanks for this effort!

One additional change to a src-based layout would make this even better, since it would simplify configuration (see my comments). Do you have time for this? If not, I think we can merge after taking @gcroci2's suggestions into account and then make a new issue/PR for moving to src-based.

[sjvrijn]

Thanks for the feedback @egpbos and @gcroci2, the PR has been updated.
Given the difficulties already indicated in #173, I've chosen to keep the move to an src setup to a separate PR that I'll work on next.

[gcroci2]

There is the same typo (almost) everywhere: reporitory instead of repository. For the rest feel free to merge when it's fixed :)

[sjvrijn]

@gcroci2 good catch! downside of making a typo during a 'find & replace all' 😅

[egpbos]

@sjvrijn great stuff, keep it coming! 😄 Be aware that the failure with >=3.9 is already fixed in #347.

[sjvrijn]

@egpbos All other tests are now fixed, I'll merge this after #347 (and #353? I guess)

[egpbos]

Ok, both other PRs are merged. There are some merge conflicts left to fix. Also, I was wondering: you now invoke -m build instead of setup.py, but doesn't that actually need build installed as a dependency (as @gcroci2 earlier suggested, see #352 (comment))?

Finally, if you are up for becoming a true UGHist, I warmly invite you to squash some of the commits (happy to do it together, I'm at the office tomorrow), but no worries if you don't have the time 😁

[sjvrijn]

@egpbos Yep, I indeed had to include build to enable the sdist build according to this StackOverflow question. Unless there's another way you know of?

Also, UGH challenge accepted 💪 I've rebased my commits on top of the merged main, and fixuped some of the corrective commits into the first one.

[egpbos]

UGH! Super nice addition, thanks!