Move setup.cfg to pyproject.toml #15247

WilliamJamieson · 2023-08-29T19:49:12Z

Description

This pull request moves all the package configuration options from setup.cfg to pyproject.toml to bring astropy inline with PEP621.

By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

github-actions · 2023-08-29T19:49:53Z

github-actions · 2023-08-29T19:49:58Z

👋 Thank you for your draft pull request! Do you know that you can use [ci skip] or [skip ci] in your commit messages to skip running continuous integration tests until you are ready?

astropy/coordinates/tests/test_representation_arithmetic.py

WilliamJamieson · 2023-08-30T14:12:06Z

I have made #15254 to get the changes black wants into astropy first. So I'll leave this in draft until #15254 gets merged.

Note that I have based this branch on the changes proposed by #15254 so commit 667bfd4 can be ignored as it will be rebased out once #15254 is merged.

nstarman

🫰

docs/conf.py

pyproject.toml

nstarman

Thanks @WilliamJamieson! It’s great to migrate away from legacy config files. Aside from the changelog check not passing, let’s get this merged!

pllim · 2023-08-31T15:33:26Z

Would be nice if @astropy/astropy-project-release-team also get a chance to review. Let's wait a bit more. Thanks!

docs/changes/15247.other.rst

nstarman · 2023-08-31T15:34:13Z

Also, squash merge?

astrofrog · 2023-09-19T18:20:06Z

I thought we did enforce 100 character line lengths?

nstarman · 2023-09-19T20:40:50Z

AFAIK that was entirely done by human review. I can't find anything in a quick perusal of the git history.

pllim · 2023-09-20T01:54:41Z

Re: pep8speaks -- someone must have accidentally re-enabled it for this repo. I disabled it again but it is still enabled in the org for astroquery and photutils. FYI.

pllim · 2023-09-20T01:56:02Z

Back to the topic at hand, would be nice to get approval from @saimn since he had concerns before.

mhvk

Looks good to me. Thanks, @WilliamJamieson!

nstarman · 2023-09-20T14:56:15Z

.pycodestyle

Agreed, see my comment on .flake8.

nstarman · 2023-09-20T14:58:07Z

astropy/utils/compat/optional_deps.py

@@ -6,7 +6,7 @@
 import warnings

 # First, the top-level packages:
-# TODO: This list is a duplicate of the dependencies in setup.cfg "all", but
+# TODO: This list is a duplicate of the dependencies in pyproject.toml "all", but
 # some of the package names are different from the pip-install name (e.g.,
 # beautifulsoup4 -> bs4).
 _optional_deps = [


In a followup PR we could handle this more automatically if python>=3.11, using tomllib & importlib.metadata

pyproject.toml

nstarman

Thanks @WilliamJamieson for biting the bullet and leading this long-desired transition.
I have dug up contentious conversations from 2021 asking for cfg->toml.

.flake8

saimn

Just a small comment, LGTM otherwise.

saimn · 2023-09-21T07:14:28Z

pyproject.toml

+authors = [
+    { name = "The Astropy Developers", email = "astropy.team@gmail.com" }
+]
+license = { file = "LICENSE.rst" }


Would be nice to retain the SPDX identifier that was added some time ago.

license = { text = "BSD-3-Clause" }

Seems more informative. I'm not sure if we can put both in license, and I cannot find a clear recommendation (https://peps.python.org/pep-0621/#license). We can also use setuptools' license-files to specify the file.

Unfortunately, we cannot do both, per PEP621 (last sentence):

The table may have one of two keys. The file key has a string value that is a relative file path to the file which contains the license for the project. Tools MUST assume the file’s encoding is UTF-8. The text key has a string value which is the license of the project whose meaning is that of the License field from the core metadata. These keys are mutually exclusive, so a tool MUST raise an error if the metadata specifies both keys.

So I had to use the tool.setuptools.liscense-files to specify the actual files, see 608019c

Since @saimn 's last comment is addressed, I am going to squash and merge. Thanks, everyone!

Missed that, sounds good then, thanks @WilliamJamieson.

saimn · 2023-09-21T07:34:18Z

Also would be great to stop polluting PRs with unrelated discussions on config files and tools. The main concern here is packaging, and if a mistake slips in the noise we will have to deal with it when the release is out.

nstarman · 2023-09-21T12:18:55Z

Agreed we don't want to have a packaging problem! @saimn are you concerned about the failing weekly cron jobs?

pllim · 2023-09-21T13:28:57Z

are you concerned about the failing weekly cron jobs?

Those are also being discussed separately over at #15351 . I plan to look into the mess that is devdeps separately today (#15363).

because it does not exist anymore after #15247 . This is similar to that patch in #15370 for v5.3.x

WilliamJamieson requested review from pllim and nstarman August 29, 2023 19:49

github-actions bot added the installation label Aug 29, 2023

pllim added this to the v6.0 milestone Aug 29, 2023

pllim added the no-changelog-entry-needed label Aug 29, 2023

pllim requested a review from a team August 29, 2023 20:06

WilliamJamieson force-pushed the feature/pyproject branch 2 times, most recently from b3f5edf to 66c2655 Compare August 29, 2023 20:40

astrofrog reviewed Aug 29, 2023

View reviewed changes

astropy/coordinates/tests/test_representation_arithmetic.py Outdated Show resolved Hide resolved

WilliamJamieson force-pushed the feature/pyproject branch 2 times, most recently from 0870b24 to 2d5e39f Compare August 30, 2023 14:00

WilliamJamieson mentioned this pull request Aug 30, 2023

Black suddenly wants to add a bunch of commas? #15254

Merged

1 task

nstarman reviewed Aug 30, 2023

View reviewed changes

docs/conf.py Outdated Show resolved Hide resolved

pyproject.toml Show resolved Hide resolved

WilliamJamieson mentioned this pull request Aug 30, 2023

Migrating project metadata from setup.cfg to pyproject.toml triggers black changes psf/black#3859

Closed

WilliamJamieson force-pushed the feature/pyproject branch 2 times, most recently from b2afea1 to 69b21ba Compare August 30, 2023 15:44

WilliamJamieson marked this pull request as ready for review August 30, 2023 15:45

nstarman added no-changelog-entry-needed and removed no-changelog-entry-needed labels Aug 30, 2023

WilliamJamieson requested review from astrofrog and nstarman August 31, 2023 13:33

nstarman approved these changes Aug 31, 2023

View reviewed changes

nstarman removed the no-changelog-entry-needed label Aug 31, 2023

pllim requested a review from saimn August 31, 2023 15:33

pllim reviewed Aug 31, 2023

View reviewed changes

docs/changes/15247.other.rst Show resolved Hide resolved

mhvk approved these changes Sep 20, 2023

View reviewed changes

nstarman reviewed Sep 20, 2023

View reviewed changes

pyproject.toml Show resolved Hide resolved

nstarman approved these changes Sep 20, 2023

View reviewed changes

eerovaher reviewed Sep 20, 2023

View reviewed changes

.flake8 Show resolved Hide resolved

WilliamJamieson force-pushed the feature/pyproject branch from 0adc2df to 66e18fe Compare September 20, 2023 17:35

saimn reviewed Sep 21, 2023

View reviewed changes

WilliamJamieson added 5 commits September 21, 2023 11:01

Move setup.cfg to pyproject.toml

7f4b12e

Fix docs build

fa252e7

Update github CI for astropy-iers-data updates

51fd767

Update code mentions of setup.cfg to pyproject.toml

cf3c028

Add changelog

6e57164

WilliamJamieson force-pushed the feature/pyproject branch from 66e18fe to 6e57164 Compare September 21, 2023 15:01

Change how license is specified

608019c

WilliamJamieson requested a review from saimn September 21, 2023 15:11

pllim enabled auto-merge (squash) September 21, 2023 15:37

pllim disabled auto-merge September 21, 2023 15:45

pllim merged commit 98710e2 into astropy:main Sep 21, 2023
50 of 55 checks passed

WilliamJamieson deleted the feature/pyproject branch September 21, 2023 16:14

WilliamJamieson mentioned this pull request Sep 21, 2023

Enable the use of pyproject-fmt #15365

Closed

1 task

pllim added a commit that referenced this pull request Sep 22, 2023

DOC: Do not link to setup.cfg in main

58b393b

because it does not exist anymore after #15247 . This is similar to that patch in #15370 for v5.3.x

saimn mentioned this pull request Sep 28, 2023

Warnings about ignored packages #15403

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move setup.cfg to pyproject.toml #15247

Move setup.cfg to pyproject.toml #15247

WilliamJamieson commented Aug 29, 2023

github-actions bot commented Aug 29, 2023

github-actions bot commented Aug 29, 2023

WilliamJamieson commented Aug 30, 2023

nstarman left a comment

nstarman left a comment

pllim commented Aug 31, 2023

nstarman commented Aug 31, 2023

astrofrog commented Sep 19, 2023

nstarman commented Sep 19, 2023

pllim commented Sep 20, 2023

pllim commented Sep 20, 2023

mhvk left a comment

nstarman Sep 20, 2023

WilliamJamieson Sep 20, 2023

nstarman Sep 20, 2023 •

edited

WilliamJamieson Sep 20, 2023

nstarman left a comment

saimn left a comment

saimn Sep 21, 2023

WilliamJamieson Sep 21, 2023

pllim Sep 21, 2023

saimn Sep 21, 2023

saimn commented Sep 21, 2023

nstarman commented Sep 21, 2023 •

edited

pllim commented Sep 21, 2023 •

edited

Move setup.cfg to pyproject.toml #15247

Move setup.cfg to pyproject.toml #15247

Conversation

WilliamJamieson commented Aug 29, 2023

Description

github-actions bot commented Aug 29, 2023

github-actions bot commented Aug 29, 2023

WilliamJamieson commented Aug 30, 2023

nstarman left a comment

Choose a reason for hiding this comment

nstarman left a comment

Choose a reason for hiding this comment

pllim commented Aug 31, 2023

nstarman commented Aug 31, 2023

astrofrog commented Sep 19, 2023

nstarman commented Sep 19, 2023

pllim commented Sep 20, 2023

pllim commented Sep 20, 2023

mhvk left a comment

Choose a reason for hiding this comment

nstarman Sep 20, 2023

Choose a reason for hiding this comment

WilliamJamieson Sep 20, 2023

Choose a reason for hiding this comment

nstarman Sep 20, 2023 • edited

Choose a reason for hiding this comment

WilliamJamieson Sep 20, 2023

Choose a reason for hiding this comment

nstarman left a comment

Choose a reason for hiding this comment

saimn left a comment

Choose a reason for hiding this comment

saimn Sep 21, 2023

Choose a reason for hiding this comment

WilliamJamieson Sep 21, 2023

Choose a reason for hiding this comment

pllim Sep 21, 2023

Choose a reason for hiding this comment

saimn Sep 21, 2023

Choose a reason for hiding this comment

saimn commented Sep 21, 2023

nstarman commented Sep 21, 2023 • edited

pllim commented Sep 21, 2023 • edited

nstarman Sep 20, 2023 •

edited

nstarman commented Sep 21, 2023 •

edited

pllim commented Sep 21, 2023 •

edited