[Epic] Migrate from setup.py/setuptools to pyproject.toml/hatch

[DawoudSheraz]

This larger issue originated from the work done in tutor core PR #1163. The PR aimed to fix #956 by switching to hatch as a project builder/manager. This change needed to have an updated pyproject.toml and potentially migrate setup.py to pyproject.toml. To ensure consistency across the codebase, the change should be done across core, tutor plugins, and plugin cookie-cutter.

Action items / PRs

• tutor feat: migrate from setup.py/setuptools to pyproject.toml/hatch #1163
• tutor-android @Abdul-Muqadim-Arbisoft
• tutor-cairn feat: migrate from setup.py/setuptools to pyproject.toml/hatch tutor-cairn#52
• tutor-credentials feat: migrate to pyproject.toml and hatch tutor-credentials#54
• tutor-discovery feat: migrate from setup.py/setuptools to pyproject.toml/hatch tutor-discovery#99
• tutor-forum @rehmansheikh222
• tutor-indigo @ahmed-arb
• tutor-jupyter @Abdul-Muqadim-Arbisoft
• tutor-mfe @DawoudSheraz
• tutor-minio feat: migrate from setup.py/setuptools to pyproject.toml/hatch tutor-minio#57
• tutor-notes feat: migrate from setup.py to pyproject.toml tutor-notes#46
• tutor-webui feat: migrate from setup.py/setuptools to pyproject.toml/hatch tutor-webui#24
• tutor-xqueue feat: migrate from setup.py to pyproject.toml tutor-xqueue#38
• cookiecutter-tutor-plugin feat: migrate from setup.py/setuptools to pyproject.toml/hatch cookiecutter-tutor-plugin#40

Related Links

• https://peps.python.org/pep-0621/
• https://packaging.python.org/en/latest/specifications/pyproject-toml/#pyproject-toml-spec
• https://hatch.pypa.io/latest/how-to/config/dynamic-metadata/
• https://stackoverflow.com/questions/72832052/is-there-a-simple-way-to-convert-setup-py-to-pyproject-toml
• https://packaging.python.org/en/latest/guides/modernize-setup-py-project/

When initializing a new hatch project, it automatically converts setup.py to pyproject. However, it won't be enough / might not be correct. We would need to config some metadata dynamically. Python docs highlight the synonymous pyproject fields for related setuptools fields. Ensure the build works as expected after the change. You might need to change commands where needed.

Note

When using pip show <package_name>, it is possible some fields, like license and author name, might not render. This is due to how hatch handles them internally.

• To ensure license is displayed, use dict format `license = {'text': '<license_name>'}
  • https://github.com/pypa/hatch/blob/hatchling-v1.8.1/backend/src/hatchling/metadata/core.py#L538-L565
  • feat: migrate from setup.py/setuptools to pyproject.toml/hatch #1163 (comment)
• For author name to display, add email and name in separate dicts instead of a single dict
  • https://github.com/pypa/hatch/blob/hatchling-v1.8.1/backend/src/hatchling/metadata/core.py#L681-L686

  {name = "Lawrence McDaniel"},
  {email = "[email protected]"},

You can look into the following for additional context

• Recommended License configuration leaves license null in project meta data pypa/hatch#1690
• https://discuss.python.org/t/clarification-regarding-the-authors-maintainers-field-in-pyproject-toml/33731/4

[regisb]

This is a great opportunity to try out the newly released sub-issues ;)

[DawoudSheraz]

This is a great opportunity to try out the newly released sub-issues ;)

Already started it for tutor-indigo overhangio/tutor-indigo#116

[DawoudSheraz]

@ghassanmas @CodeWithEmad @jfavellar90 Can you take care of your respective plugins, please? Thanks
Let me know if you do not have the capacity at the moment to deal with this.

[CodeWithEmad]

That cool. I'll take care of the cookie-cutter in the coming days.

Update: Here you are: overhangio/cookiecutter-tutor-plugin#40

[DawoudSheraz]

@ghassanmas @jfavellar90 A reminder. Let me know if you do not have the capacity to take this on. Thanks

[jfavellar90]

@DawoudSheraz I'll reserve capacity this week :)

[fghaas]

@DawoudSheraz Re tutor-forum, I'm afraid you may have me confused with someone else. :) I am not a tutor-forum contributor, and the Open edX platforms I help maintain don't use it. Could you have mixed up some names/handles?

[DawoudSheraz]

@DawoudSheraz Re tutor-forum, I'm afraid you may have me confused with someone else. :) I am not a tutor-forum contributor, and the Open edX platforms I help maintain don't use it. Could you have mixed up some names/handles?

Oh, sorry. I tagged you accidentally. Apologies for the confusion. I have updated it.

[fghaas]

No problem, thanks!

[jfavellar90]

@DawoudSheraz notes and xqueue PR's ready