feat: migrate from setup.py/setuptools to pyproject.toml/hatch #1163
Conversation
This is an attempt both to modernize the packaging and to fix mypy testing in editable mode (issue #956). Packaging seems to work, but mypy testing still fails. Will now attempt to migrate from setuptools to hatch for building.
regisb
force-pushed
the
regisb/pyproject.toml
branch
from
a071906 to
73441d2
Compare
| pip install . | ||
| pip install -r requirements/dev.txt | ||
|
|
||
| bootstrap-dev-plugins: bootstrap-dev ## Install dev requirements and all supported plugins |
There was a problem hiding this comment.
Any particular reasons for merging this? I get this is being made part of full, just thinking if someone was using this in their automation and can break.
There was a problem hiding this comment.
The make are not supposed to be part of the Tutor API, so I think it's OK to make breaking changes here. The goal of this change is to get rid of an unused command.
| pip-compile ${COMPILE_OPTS} requirements/base.in | ||
| pip-compile ${COMPILE_OPTS} requirements/dev.in | ||
| pip-compile ${COMPILE_OPTS} requirements/docs.in |
There was a problem hiding this comment.
What's the reason for having COMPILE_OPTS? What values can it have?
There was a problem hiding this comment.
This is a technique that I also used in edx-platform to de-duplicate the list of *.in files in the Makefile.
- migrate from setup.py/setuptools to pyproject.toml/hatch. - This commit will keep the tutor-discovery in sync with the tutor core. For more details view this PR in tutor: overhangio/tutor#1163.
- migrate from setup.py/setuptools to pyproject.toml/hatch. - This commit will keep the tutor-discovery in sync with the tutor core. For more details view this PR in tutor: overhangio/tutor#1163.
- migrate from setup.py/setuptools to pyproject.toml/hatch. - This commit will keep the tutor-discovery in sync with the tutor core. For more details view this PR in tutor: overhangio/tutor#1163.
|
|
||
| [project] | ||
| name = "tutor" | ||
| license = {file = "LICENSE.txt"} |
There was a problem hiding this comment.
As we are now using the entire license file as the license, running pip show tutor displays the entire license file against the license field making it a cluttered mess if someone wants to read the other attributes of the package.
Instead I propose changing this to a text:
license = {text = "AGPL-3.0-only"}
The license names are available here.
CC: @DawoudSheraz
There was a problem hiding this comment.
Thanks for highlighting this. Using text should be good enough, the entire license content will certainly make pip show difficult to navigate. Also, I don't think we need to have dict with text key, we can add the license name directly
license = "AGPL-3.0-only"
There was a problem hiding this comment.
Also, I don't think we need to have dict with text key, we can add the license name directly
Unfortunately, it doesn't work for me without the dict and text key, it shows empty otherwise 😕.
While investigating issue #956, I realized that the issue might be resolved if we switched from setuptools to hatch as package builder. But to achieve that, we also need to migrate from setup.py to pyproject.toml. This was a long overdue chore, as setup.py is no longer recommended (see PEP 621).
I'm not sure whether we should be merging this change now, later (or ever). I think this should be safe... So I would lean towards merging it now (and eventually migrate plugins and cookiecutter to pyproject.toml as well). But I'm curious what ya'll think @kdmccormick @DawoudSheraz.