Update package metadata

[ofek]

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 deprecated.

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 and MANIFEST.in. The build backend hatchling (of which I am a maintainer in the PyPA) is now used as that is the default in the official Python packaging tutorial. Hatchling is available on all the major distribution channels such as Debian, Fedora, Arch Linux, conda-forge, Nixpkgs, Alpine Linux, FreeBSD/OpenBSD, Gentoo Linux, MacPorts, OpenEmbedded, Spack, etc.

Notes

Version location

The version is now stored in web3/__init__.py, removing the need for pkg_resources and thus reducing import time of web3 by ~400ms for me locally.

Source distribution

The ones on PyPI are erroneously shipping a build artifact *.egg-info from pip install -e .:

Also, the old MANIFEST.in was trying to ship a requirements.txt but there is no such file, only requirements-docs.txt.

Both of these issues are now fixed.

Cute Animal Picture

[kclowes]

Thanks for this PR! We have a few other things that are higher on our priority list at the moment, so it may take us a bit to review this.

[ofek]

@kclowes There was a conflict so I rebased 🙂

[ofek]

CI is passing btw

[ofek]

@kclowes Your PR #2622 caused many conflicts so I rebased again

[ofek]

@kclowes PR #2630 caused another conflict so I rebased again

[ofek]

cc @fselmo

[ofek]

same errors on master

[ofek]

rebased, now passing

[kclowes]

Thanks @ofek. Once we get The Merge changes out the door across our libraries we'll take a look. Thanks for your patience!

[ofek]

@kclowes Good job with The Merge! I rebased to resolve the conflict with your PR #2623

[ofek]

@kclowes I rebased to resolve the conflict with your commit to master 1be0745

[ofek]

@kclowes @pacrob I rebased to resolve the conflict with this PR #2657

[ofek]

@kclowes @fselmo @pacrob I rebased to resolve the conflict with this commit to master 14cb121 and this PR #2671

I don't know how much longer I can keep doing this 😅

[ofek]

@kclowes @fselmo @pacrob I rebased to resolve the conflict with this PR #2666

[pacrob]

Hi @ofek. I'm sorry we've been so long in getting back to you. We discussed your proposal today and decided that we are going to stick with our current process at this time. For future proposals, please open an issue first so we can discuss changes without putting so much work into it first.

[ofek]

Okay! Can you provide any details about why?

[pacrob]

Yep. We know our current process and it works well. Hatchling does look good, but there's no compelling reason make the change.

[ofek]

What about setuptools + removing setup.py?

[pacrob]

You are correct, we do have room for improvement. We have talked about removing setup.py and making more use of pyproject.toml, and plan to revisit our build process in the new year. But we have a dozen or so libraries that we want to standardize the process for, and right now we're focused on getting v6 out.

We do absolutely appreciate your contributions! Again, in order to allow us to fit things into our roadmap, please introduce ideas as Issues so they can be discussed first. Thank you!