Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to pyproject.toml over setup.py #118

Merged
merged 1 commit into from Aug 16, 2022
Merged

Conversation

sethmlarson
Copy link
Collaborator

@sethmlarson sethmlarson commented Apr 2, 2022

  • Switches to using Flit instead of setuptools to build the packages due to being pure Python
  • Switches to pyproject.toml for static packaging metadata
  • Adds the Python 3.11 classifier

@jribbens
Copy link
Collaborator

jribbens commented Apr 3, 2022

Why is this a good thing?

@kjd
Copy link
Owner

kjd commented Apr 4, 2022

I'll admit to not being up-to-date enough on the state of the art of packaging to know if this desirable at this point. I think this project values backward compatibility so my initial concern is any unintended side-effects of making this change.

I am very happy to be educated otherwise I will do some reading!

@sethmlarson
Copy link
Collaborator Author

@kjd @jribbens Great questions!

Why pyproject.toml?

This file describes the build system in use, so regardless of whether we accept Flit or moving packaging metadata to a static file (setup.py -> pyproject.toml) we should probably have this file to conform with current standards and get build isolation. Here's a longer explanation about pyproject.toml.

Why Flit?

Flit is a PEP 517 compliant builder that is optimized for pure Python packages that have <module>.__version__ which fits the bill pretty well for idna. There shouldn't be any breakage or changes to installers, only builders (us and OS re-packagers downstream) will need to do anything. If it's decided we want to stick with setuptools that would be fine too.

@kjd kjd merged commit ab07fc6 into kjd:master Aug 16, 2022
@sethmlarson sethmlarson deleted the pyproject-toml branch August 16, 2022 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants