migrate packaging to pyproject.toml #9056

deronnax · 2023-07-27T13:38:21Z

Just an initiative of my own.

Don't forget to squash merge the PR.

deronnax · 2023-07-29T16:56:20Z

OK, it's almost ready except:

It can't work on python 3.6 because having setuptools being able to read metadata from pyproject.toml requires setuptools > 61.2, which does not support python 3.6 anymore.
I need to figure out what is conftest.py doing with the package_root

terencehonles · 2023-10-04T23:07:23Z

I need to figure out what is conftest.py doing with the package_root

This is unrelated to your PR and I fixed it with #9129

deronnax · 2023-10-05T22:49:46Z

Wow. It works indeed. Thank you so much.

auvipy

We need to hold this off for now. As we got other priorities.

deronnax · 2023-10-06T09:36:29Z

Sure. A vague estimation of when it would become envisageable ?

deronnax · 2024-02-05T12:48:32Z

To merge after #9210, I hope.

pyproject.toml

it was automatically migrated but flake8 doesn't support the pyproject.toml format

zip-safe is deprecated and doesn't do anything. exclude 'tests*' is already the default behaviour

deronnax · 2024-02-27T13:43:27Z

watch-out: this PR is intended to be squash-merged

tomchristie · 2024-02-27T13:59:45Z

So... this is a good example of a nice little pr that's a bit stalled. I don't really have any extra bandwidth to keep this moving, given existing commitments. Should we be having a discussion about getting the project into jazzband.co so that we've got a lower barrier of entry for new maintainers?

deronnax · 2024-02-27T14:10:33Z

Hey, that's a very interesting decision that is (way) beyond the scope of my humble little PR. Maybe let's open a dedicated issue ou GitHub discussion?

browniebroke · 2025-01-30T09:28:05Z

@auvipy did you have time to take a closer look? Is my previous message helpful to review what's going on and what's changed?

auvipy · 2025-01-30T09:32:50Z

We can defer this until 3.16 release

browniebroke · 2025-04-02T17:45:54Z

We can defer this until 3.16 release

Shall we reconsider this now? I know that setuptools are doing some changes to discourage more and more running python setup.py. Implementing this would ensure we follow packaging best practices.

The conflicts are (I think) caused by #9670 and #9634

EDIT: this might conflict too if merged before: #9681

# Conflicts: # .pre-commit-config.yaml # setup.py

stale · 2025-07-19T15:30:56Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

ulgens · 2025-07-19T15:43:48Z

@browniebroke Do we have a blocker? What is needed to push this forward?

browniebroke · 2025-07-24T07:49:30Z

Do we have a blocker? What is needed to push this forward?

I don't have any blockers anymore - happy to go ahead with this one. Perhaps for 3.17?

terencehonles

This looks pretty good to me and hopefully we can get this merged soon! A couple small notes based on recent pyproject.toml changes that could be addressed while waiting for an official ✔️

pyproject.toml

terencehonles · 2025-08-04T08:05:14Z

pyproject.toml

+requires-python = ">=3.9"
+dependencies = ["django>=4.2"]


Unrelated to my other comments, but a little whitespace makes this a little easier to read:

Suggested change

requires-python = ">=3.9"

dependencies = ["django>=4.2"]

requires-python = ">= 3.9"

dependencies = ["django >= 4.2"]

I don't really mind the way it is now (actually I prefer it).

I'd recommend https://github.com/tox-dev/pyproject-fmt to standardize this kind of stuff.

+1 to this comment since the project is already using pre-commit

Yes it was on the back of my mind, but didn't want to scope creep too much here 😊 let's review it what this lands

you don't think this should just be added since this is the PR that introduces the file and the pre-commit check will just keep the formatting consistent going forward?

Hum... Yes, I think you're right. It's a new file is added here so let's keep it all together 👍🏻

Co-authored-by: Terence Honles <terencehonles@users.noreply.github.com>

https://choosealicense.com/licenses/bsd-3-clause/

The PR has changed significantly

browniebroke · 2025-08-07T21:03:56Z

A couple small notes based on recent pyproject.toml changes that could be addressed while waiting for an official

Thanks for the reviews, I've heard about these changes but forgot about them. Applied your suggestions.

browniebroke · 2025-08-07T21:09:00Z

With 3.16.1 now out of the way, I'd like to get this one merged and released on 3.16.2, either on its own or with very minor other changes. 3.17 will have a number of other more significant changes which means we'll keep postponing this.

Thoughts?

browniebroke · 2025-08-07T21:14:11Z

setup.py

I realise this was discussed before but I would vote for removing this file entirely.

Django has dropped it since (at least) version 4.2, so if Django can do it, I'd say we can too.

I hadn't seen the discussion, but I would vote the same. It's really not providing much other than some "backwards compatibility" for ancient packagers, and they might not be compatible with newer build backends (though I would expect that to be somewhat unlikely). I assume most people are installing via wheels and if it breaks for someone using a non standard approach they can finally update their setup as they have had years to do so.

deronnax marked this pull request as draft July 27, 2023 13:40

deronnax force-pushed the migrate_setuppy_to_pryoject.toml branch from 6344069 to 42d468b Compare July 27, 2023 13:41

deronnax force-pushed the migrate_setuppy_to_pryoject.toml branch from 8c65e6d to 6e67258 Compare July 29, 2023 17:07

deronnax force-pushed the migrate_setuppy_to_pryoject.toml branch from 6e67258 to b16826c Compare October 5, 2023 16:28

deronnax marked this pull request as ready for review October 5, 2023 22:48

auvipy self-requested a review October 6, 2023 05:42

auvipy requested changes Oct 6, 2023

View reviewed changes

deronnax changed the title ~~migrate setup.cfg to pyproject.toml~~ migrate packaging to pyproject.toml Oct 7, 2023

Viicos reviewed Feb 27, 2024

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

deronnax added 10 commits February 27, 2024 14:34

migrate setup.cfg to setup.py

3136996

restore a setup.py stub

401de87

migrate setup.cfg to pyproject.toml

6019f1d

tox: isolated build

121caba

remove python 3.6

c2062da

get package version from rest_framework.__version__

a71ed6a

more concise readme inclusion

0bcd152

remove flake8 config from pyproject.toml

34840fd

it was automatically migrated but flake8 doesn't support the pyproject.toml format

remove 'zip-safe' and 'exclude' arguments

9b6e714

zip-safe is deprecated and doesn't do anything. exclude 'tests*' is already the default behaviour

move back non-packing related config into setup.cfg

cf25dcd

deronnax force-pushed the migrate_setuppy_to_pryoject.toml branch from 12a5a0b to cf25dcd Compare February 27, 2024 13:37

deronnax added 2 commits February 27, 2024 14:40

remove unneeded include-package-data field

040ded0

remove 'license-files' field

9ce6b62

browniebroke mentioned this pull request Mar 26, 2025

Refactor get_version to use a context manager for safe file handling #9669

Closed

browniebroke added 2 commits April 16, 2025 17:55

Merge branch 'master' into migrate_setuppy_to_pryoject.toml

63d340b

# Conflicts: # .pre-commit-config.yaml # setup.py

Backport changes from setup.py in upstream

3542e40

stale bot added the stale label Jul 19, 2025

stale bot removed the stale label Jul 24, 2025

browniebroke modified the milestones: 3.16, 3.17 Jul 24, 2025

terencehonles approved these changes Aug 4, 2025

View reviewed changes

browniebroke and others added 3 commits August 7, 2025 21:39

Merge branch 'master' into migrate_setuppy_to_pryoject.toml

3b6e49c

Update license-related package metadata according to PEP-639

c086598

Co-authored-by: Terence Honles <terencehonles@users.noreply.github.com>

Fix SPDX Identifier

1018978

https://choosealicense.com/licenses/bsd-3-clause/

browniebroke reviewed Aug 7, 2025

View reviewed changes

browniebroke added 2 commits August 8, 2025 18:17

Add pyproject-fmt to pre-commit hooks

2c8d10d

Run pyproject-fmt

3150ff1

browniebroke modified the milestones: 3.17, 3.16 Aug 9, 2025

browniebroke added the Packaging label Aug 9, 2025

auvipy modified the milestones: 3.16, 3.17 Aug 10, 2025

Uh oh!

migrate packaging to pyproject.toml #9056

Are you sure you want to change the base?

migrate packaging to pyproject.toml #9056

Conversation

deronnax commented Jul 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

deronnax commented Jul 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

terencehonles commented Oct 4, 2023

Uh oh!

deronnax commented Oct 5, 2023

Uh oh!

auvipy left a comment

Choose a reason for hiding this comment

Uh oh!

deronnax commented Oct 6, 2023

Uh oh!

deronnax commented Feb 5, 2024

Uh oh!

Uh oh!

deronnax commented Feb 27, 2024

Uh oh!

tomchristie commented Feb 27, 2024

Uh oh!

deronnax commented Feb 27, 2024

Uh oh!

browniebroke commented Jan 30, 2025

Uh oh!

auvipy commented Jan 30, 2025

Uh oh!

browniebroke commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stale bot commented Jul 19, 2025

Uh oh!

ulgens commented Jul 19, 2025

Uh oh!

browniebroke commented Jul 24, 2025

Uh oh!

terencehonles left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

browniebroke commented Aug 7, 2025

Uh oh!

browniebroke commented Aug 7, 2025

Uh oh!

browniebroke Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

deronnax commented Jul 27, 2023 •

edited

Loading

deronnax commented Jul 29, 2023 •

edited

Loading

browniebroke commented Apr 2, 2025 •

edited

Loading

browniebroke Aug 7, 2025 •

edited

Loading