Update package metadata #338

ofek · 2022-03-27T20:30:57Z

Background

Hello there! The Python packaging ecosystem has standardized on the interface for build backends (PEP 517/PEP 660) and the format for metadata declaration (PEP 621/PEP 631). As a result, the execution of setup.py files is now heavily discouraged.

So, I'm spending my free time updating important projects so that they are modernized and set an example for others 😄

Summary of changes

This implements PEP 621, obviating the need for setup.py, setup.cfg, and MANIFEST.in. The build backend hatchling (of which I am a maintainer) is quite stable and actively developed, the only reason the version is 0.x is because 1.0.0 will drop support for Python 2. It's also on the major distribution channels such as Debian, Fedora, Arch Linux, conda-forge, Nixpkgs, etc.

Other projects have done this such as pipx, tox, all Datadog Agent integrations, etc.

In comparison to setuptools, Hatchling has reproducible builds, supports the modern PEP 660 editable installation standard, has a more intuitive plugin system, and the codebase is an order of magnitude smaller thus making it more auditable and less prone to bugs (setuptools is based on a deprecated standard library module that it now must vendor).

Notes

Similar to Add support for Python 3.7 and 3.8, drop EOL 3.4 #228, this also drops support for EOL Python 3.x versions since hatchling and other build backends like setuptools have already done so. This will not break anything because pip only looks for version candidates that satisfy the requires-python field. Here are stats for the curious: https://pypistats.org/packages/colorama
The source distributions on PyPI are erroneously shipping a build artifact *.egg-info from pip install -e .; this is now fixed:

ofek · 2022-05-08T23:22:24Z

Just FYI Hatch was adopted by the Python Packaging Authority:

tartley · 2022-06-14T17:49:09Z

Hi. Thanks for the contribution! We're talking about making a release, and this seems like a laudable change. I'd like to get it in if I can. @ofek Presumably your opinion is that it is currently good to merge as-is? I'll check it out...

Makefile

tartley · 2022-06-14T18:16:17Z

I see there are failures on 2.7 on Windows. I'll try to run a build on master as a sanity check.

ofek · 2022-06-14T18:31:04Z

Fixed, this looks good to me now!

ofek · 2022-06-14T18:32:17Z

When you drop py2 just remove the pin

tartley · 2022-06-14T20:31:47Z

We're scrambling to find a little time to make a release before going on vacation. In order to keep things simple, I'm going to postpone merging this right now, but will merge it and make another release after my vacation, around July 5th.

Thanks heaps for the contribution, and all your work leading up to this point! :-)

ofek · 2022-06-14T21:27:05Z

Happy to help! Have fun 🙂

wiggin15 · 2022-06-15T07:55:31Z

Hi @ofek . Can you explain the benefits of using hatchling vs. using python -m build once we have pyproject.toml?
Maybe these are just two different build backends and build are using a name that is too generic - but my knowledge about these recent developments is not up-to-date so this is a bit confusing.

ofek · 2022-06-15T12:20:38Z

@wiggin15 Hey! See https://peps.python.org/pep-0517/

build is a build frontend like pip. So python -m build and pip wheel . both invoke the configured build backend which is what builds the sdist & wheel. Hatchling is a build backend like setuptools.

Some benefits:

easier to configure
reproducible builds
plugin ecosystem
small, modern codebase which makes it easier to audit

wiggin15 · 2022-06-15T14:40:21Z

Thanks. I think I got it.

wiggin15 · 2022-06-19T06:50:25Z

Makefile

@@ -51,15 +50,14 @@ test: ## Run tests
 # build packages

 build: ## Build a release (sdist and wheel)
-	$(python) -m pip install --upgrade setuptools wheel
-	$(python) setup.py sdist bdist_wheel
+	$(python) -m pip install --upgrade build


Do you think maybe "build" should be in requirements-dev.txt (which is installed during make bootstrap - see the release process in README-hacking.md) instead of being installed here?

I think not since it's unrelated to testing; I think twine should also not be in there

requirements-dev.txt is not just for testing - we install these packages when running make bootstrap before running make build/make release as part of the build/release process.

OTOH now I see that we ran pip install for setuptools and wheel before this change...

Anyway, this is not blocking a merge.

pyproject.toml

wiggin15 · 2022-06-19T06:53:19Z

I'm ok with merging this now that we released v0.4.5. @ofek can you please rebase the PR to resolve the latest conflicts? Thanks.

ofek · 2022-06-19T15:06:17Z

Done!

wiggin15 · 2022-06-19T15:42:24Z

Makefile

 .PHONY: build

 test-release: build ## Test a built release
 	./test-release
 .PHONY: test-release

 release: ## Upload a built release
-	$(twine) upload dist/colorama-$(version)*
+	$(twine) upload dist/colorama-*{.whl,.tar.gz}


We encountered an issue in our last release where the globs using {} didn't work in the Makefile. We had to remove them.

wiggin15 · 2022-06-19T15:43:36Z

tox.ini

@@ -1,5 +1,6 @@
 [tox]
-envlist = py27, py35, py36, py37, py38, py39, py310, pypy, pypy3


If we are removing py35 and py36 from the testing matrix we should reflect that in the README (we list tested versions under Installation)

wiggin15 · 2022-06-19T15:46:29Z

Sorry for piling on more comments each time, and thanks for working with us :)
I feel like we're almost there!

ofek · 2022-06-19T15:55:37Z

Addressed!

wiggin15 · 2022-06-20T05:58:12Z

Thank you very much @ofek . This brings colorama to the modern age of Python packaging 🥳

tartley · 2022-10-19T18:47:52Z

We have a release candidate on PyPI containing this PR. Thank you for your contributions! https://pypi.org/project/colorama/0.4.6rc1/

If nobody spots any problems with it, I'll push the final 0.4.6 tomorrow.

ofek · 2022-10-20T13:50:41Z

Awesome!

or more like four: ``` $ pipdeptree hatchling==1.11.1 - editables [required: >=0.3, installed: 0.3] - packaging [required: >=21.3, installed: 21.3] - pyparsing [required: >=2.0.2,!=3.0.5, installed: 3.0.9] - pathspec [required: >=0.10.1, installed: 0.10.1] - pluggy [required: >=1.0.0, installed: 1.0.0] - tomli [required: >=1.2.2, installed: 2.0.1] ``` Let's monitor how the situation evolves, and whether other packages start requiring hatchling, but for now I am not going to add four new packages into the trusted base set... Pinning colorama to an older version for now. related: tartley/colorama#338 tartley/colorama#349

0.4.6 Current release * tartley/colorama#139 Add alternative to 'init()', called 'just_fix_windows_console'. This fixes many longstanding problems with 'init', such as working incorrectly on modern Windows terminals, and wonkiness when init gets called multiple times. The intention is that it just makes all Windows terminals treat ANSI the same way as other terminals do. Many thanks the njsmith for fixing our messes. * tartley/colorama#352 Support Windows 10's ANSI/VT console. This didn't exist when Colorama was created, and avoiding us causing havok there is long overdue. Thanks to segeviner for the initial approach, and to njsmith for getting it merged. * tartley/colorama#338 Internal overhaul of package metadata declaration, which abolishes our use of the now heavily discouraged setuptools (and hence setup.py, setup.cfg and MANIFEST.in), in favor of hatchling (and hence pyproject.toml), generously contributed by ofek (author of hatchling). This includes dropping support Python3.5 and 3.6, which are EOL, and were already dropped from setuptools, so this should not affect our users. * tartley/colorama#353 Attention to detail award to LqdBcnAtWork for a spelling fix in demo06

ofek force-pushed the modernize-metadata branch 2 times, most recently from 476f164 to 1918721 Compare March 27, 2022 20:39

tartley reviewed Jun 14, 2022

View reviewed changes

Makefile Outdated Show resolved Hide resolved

tartley added the 0.4.6 Get merged for 0.4.6. release label Jun 14, 2022

tartley mentioned this pull request Jun 14, 2022

replace tox.ini with pyproject.toml #326

Closed

wiggin15 reviewed Jun 19, 2022

View reviewed changes

pyproject.toml Show resolved Hide resolved

ofek and others added 4 commits June 19, 2022 10:51

Update package metadata

ddf34ea

Pin for Python 2

72ffc46

Comment the reversion required when dropping Py2.7

d4fc1f0

fix Windows

ae087c9

ofek force-pushed the modernize-metadata branch from 5c0dc0d to ae087c9 Compare June 19, 2022 14:51

wiggin15 reviewed Jun 19, 2022

View reviewed changes

address

0086cc6

wiggin15 merged commit cd653d7 into tartley:master Jun 20, 2022

ofek deleted the modernize-metadata branch June 20, 2022 06:05

KOLANICH mentioned this pull request Aug 5, 2022

Get rid of hatchling and return back to setuptools #349

Closed

realcharmer mentioned this pull request May 3, 2023

Update ulozto-downloader and python3-colorama void-linux/void-packages#43725

Merged

kiike mentioned this pull request Mar 13, 2024

Switch to pyproject.toml papis/papis#607

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update package metadata #338

Update package metadata #338

ofek commented Mar 27, 2022 •

edited

Loading

ofek commented May 8, 2022

tartley commented Jun 14, 2022

tartley commented Jun 14, 2022

ofek commented Jun 14, 2022

ofek commented Jun 14, 2022

tartley commented Jun 14, 2022

ofek commented Jun 14, 2022

wiggin15 commented Jun 15, 2022

ofek commented Jun 15, 2022

wiggin15 commented Jun 15, 2022

wiggin15 Jun 19, 2022

ofek Jun 19, 2022

wiggin15 Jun 19, 2022 •

edited

Loading

wiggin15 commented Jun 19, 2022

ofek commented Jun 19, 2022

wiggin15 Jun 19, 2022

wiggin15 Jun 19, 2022

wiggin15 commented Jun 19, 2022

ofek commented Jun 19, 2022

wiggin15 commented Jun 20, 2022

tartley commented Oct 19, 2022

ofek commented Oct 20, 2022

		@@ -1,5 +1,6 @@
		[tox]
		envlist = py27, py35, py36, py37, py38, py39, py310, pypy, pypy3

Update package metadata #338

Update package metadata #338

Conversation

ofek commented Mar 27, 2022 • edited Loading

Background

Summary of changes

Notes

ofek commented May 8, 2022

tartley commented Jun 14, 2022

tartley commented Jun 14, 2022

ofek commented Jun 14, 2022

ofek commented Jun 14, 2022

tartley commented Jun 14, 2022

ofek commented Jun 14, 2022

wiggin15 commented Jun 15, 2022

ofek commented Jun 15, 2022

wiggin15 commented Jun 15, 2022

wiggin15 Jun 19, 2022

Choose a reason for hiding this comment

ofek Jun 19, 2022

Choose a reason for hiding this comment

wiggin15 Jun 19, 2022 • edited Loading

Choose a reason for hiding this comment

wiggin15 commented Jun 19, 2022

ofek commented Jun 19, 2022

wiggin15 Jun 19, 2022

Choose a reason for hiding this comment

wiggin15 Jun 19, 2022

Choose a reason for hiding this comment

wiggin15 commented Jun 19, 2022

ofek commented Jun 19, 2022

wiggin15 commented Jun 20, 2022

tartley commented Oct 19, 2022

ofek commented Oct 20, 2022

ofek commented Mar 27, 2022 •

edited

Loading

wiggin15 Jun 19, 2022 •

edited

Loading