Consolidate setup.py metadata, remove old setup.py files#1376
Consolidate setup.py metadata, remove old setup.py files#1376jorisvandenbossche merged 7 commits intoshapely:mainfrom
Conversation
setup.py
Outdated
| description="Manipulation and analysis of geometric objects", | ||
| # description="GEOS wrapped in numpy ufuncs", | ||
| # description="Geometric objects, predicates, and operations", |
There was a problem hiding this comment.
The two descriptions commented out are from pygeos and shapely, respectively. The one that I used now (not commented out) is the one from the github repo's tagline here. Any preferences? (or alternatives?)
There was a problem hiding this comment.
I like the one you selected 👍
setup.py
Outdated
| author="Sean Gillies, Casper van der Wel, and the Shapely contributors", | ||
| author_email="sean.gillies@gmail.com, caspervdw@gmail.com", |
There was a problem hiding this comment.
It's not very clear what the requirements are around "author" (and you also have "maintainer" as alternative/additional field), for example, should it be a single person, or can it be multiple as I did here?
Some other packages put the developer mailing list as "email", but that's not something we have.
There was a problem hiding this comment.
I think it is best to sidestep this issue by not including this field at all. I strongly prefer people raising issues at github instead of emailing me.
Concerning the “author” field; I am a bit torn on this point. I like to have some credits for designing and building pygeos, but others have invested considerable amount of effort in the past years as well (like yourself @jorisvandenbossche). What warrants being listed as an “author”?
In practice this field gets set by the creator of the project. There is something sensible in this because it is mostly the one who thought up the idea of the project in the first place. Numpy for instance has Travis Oliphaunt as author but “NumPy maintainers” as maintainer. And maintainer supersedes author in the PKG_INFO (see docs https://setuptools.pypa.io/en/latest/references/keywords.html) Related to this is #1379
There was a problem hiding this comment.
So then keeping "Sean Gillies" as author and add "Shapely contributors" as maintainer? That would be fine with me as well.
(numpy also has " et al." after the author name)
Pull Request Test Coverage Report for Build 2488429169
💛 - Coveralls |
|
Is there any apatite in moving static metadata to Further down the pipe is moving static metadata to |
Yes, although I was maybe thinking we can also wait a bit longer and directly move to pyproject.toml? (although the move from setup.cfg to pyproject.toml might be trivial, didn't check that) |
|
Transferring metadata from setup.cfg -> pyproject.toml is not really 1:1, as there is a bit of reorganisation (described in PEP 621). While it is experimental support from setuptools, modern PyPA tools like |
setup.py
Outdated
| url="https://github.com/shapely/shapely", | ||
| keywords="geometry topology gis", | ||
| author="Sean Gillies", | ||
| author_email="sean.gillies@gmail.com", |
There was a problem hiding this comment.
Comment from discussion: leave out email
|
Going to merge this so we have a proper setup.py. We can do a move to pyproject.toml in a follow-up PR. |
After merging pygeos into shapely, the
setup()function in setup.py for now only had a minimal content to have the installation working. With this PR, I am also trying to consolidate the additional metadata passed tosetup().For the most part this combines the values of the previous setup.py files from shapely and pygeos (those were kept as setup_shapely.py and setup_pygeos.py for now, which I deleted in this PR), except for a few open questions (see the inline comments as well):
cc @sgillies @caspervdw