Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

migrate packaging to pyproject.toml #9056

Open
wants to merge 26 commits into
base: master
Choose a base branch
from
Open

migrate packaging to pyproject.toml #9056

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
3136996
migrate setup.cfg to setup.py
deronnax Jul 27, 2023
401de87
restore a setup.py stub
deronnax Jul 27, 2023
6019f1d
migrate setup.cfg to pyproject.toml
deronnax Jul 27, 2023
121caba
tox: isolated build
deronnax Jul 28, 2023
c2062da
remove python 3.6
deronnax Jul 29, 2023
a71ed6a
get package version from rest_framework.__version__
deronnax Oct 6, 2023
0bcd152
more concise readme inclusion
deronnax Oct 6, 2023
34840fd
remove flake8 config from pyproject.toml
deronnax Oct 7, 2023
9b6e714
remove 'zip-safe' and 'exclude' arguments
deronnax Oct 7, 2023
cf25dcd
move back non-packing related config into setup.cfg
deronnax Oct 7, 2023
040ded0
remove unneeded include-package-data field
deronnax Feb 27, 2024
9ce6b62
remove 'license-files' field
deronnax Feb 27, 2024
c4bcfc4
Revert "remove python 3.6"
deronnax Feb 28, 2024
2770f5e
Merge branch 'master' into migrate_setuppy_to_pryoject.toml
deronnax Mar 20, 2024
6f8da97
Merge branch 'master' into migrate_setuppy_to_pryoject.toml
deronnax Oct 13, 2024
2ef6126
pre-commit: tomli optional additional dependency
deronnax Oct 16, 2024
c8030fc
remove final wording note from pyproject.toml
deronnax Oct 16, 2024
0101d89
remove flake8 section in pyproject
deronnax Oct 16, 2024
c1c39d4
delete setup.py
deronnax Oct 16, 2024
561bd4c
ci: remove tox 'isolated_build'
deronnax Oct 17, 2024
29205f0
restore minimalist setup.py
deronnax Oct 18, 2024
1278968
also update build/upload instruction
deronnax Nov 15, 2024
06bebc2
remove parameters for which the value is already the default
deronnax Dec 1, 2024
ea10c54
use 'rest_framework' package namespace
deronnax Dec 1, 2024
5729b02
Revert "use 'rest_framework' package namespace"
deronnax Dec 1, 2024
7770fe4
include "rest_framework*" in pyproject.toml
deronnax Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ jobs:
strategy:
matrix:
python-version:
- '3.6'
- '3.7'
- '3.8'
- '3.9'
Expand All @@ -37,18 +36,9 @@ jobs:
- name: Install dependencies
run: python -m pip install --upgrade codecov tox

- name: Install tox-py
if: ${{ matrix.python-version == '3.6' }}
run: python -m pip install --upgrade tox-py

- name: Run tox targets for ${{ matrix.python-version }}
if: ${{ matrix.python-version != '3.6' }}
run: tox run -f py$(echo ${{ matrix.python-version }} | tr -d .)

- name: Run tox targets for ${{ matrix.python-version }}
if: ${{ matrix.python-version == '3.6' }}
run: tox --py current

- name: Run extra tox targets
if: ${{ matrix.python-version == '3.9' }}
run: |
Expand Down
53 changes: 53 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
[build-system]
requires = ["setuptools>=61.2"]
build-backend = "setuptools.build_meta"

[project]
name = "djangorestframework"
readme = "README.md"
authors = [{name = "Tom Christie", email = "[email protected]"}]
license = {text = "BSD"}
description = "Web APIs for Django, made easy."
classifiers = [
"Development Status :: 5 - Production/Stable",
"Environment :: Web Environment",
"Framework :: Django",
"Framework :: Django :: 3.0",
"Framework :: Django :: 3.1",
"Framework :: Django :: 3.2",
"Framework :: Django :: 4.0",
"Framework :: Django :: 4.1",
"Framework :: Django :: 4.2",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still true?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not in the current state, indeed

"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3 :: Only",
"Topic :: Internet :: WWW/HTTP",
]
requires-python = ">=3.7"
dependencies = [
"django>=3.0",
'backports.zoneinfo;python_version<"3.9"',
]
dynamic = ["version"]

[tool.setuptools.dynamic]
version = {attr = "rest_framework.__version__"}

[project.urls]
Homepage = "https://www.django-rest-framework.org/"
Funding = "https://fund.django-rest-framework.org/topics/funding/"
Source = "https://github.com/encode/django-rest-framework"
Changelog = "https://www.django-rest-framework.org/community/release-notes/"

[tool.setuptools.packages.find]
namespaces = false
Copy link
Contributor

@terencehonles terencehonles Nov 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason you're disabling namespaces? I believe you can also just specify the packages directly since there is only one:

Suggested change
[tool.setuptools.packages.find]
namespaces = false
packages = ["rest_framework"]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I disabled them because they were disabled originally, using find_packages in the setup.py instead of find_namespace_packages. I tried your suggestion but it broke the CI, so I reverted it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, thanks for trying. It appears I misunderstood the default behavior for nested packages.

You'd need to try the following:

Suggested change
[tool.setuptools.packages.find]
namespaces = false
[tool.setuptools.packages.find]
include = ["rest_framework*"]

I used the build module to build a wheel and with my original suggestion it was warning that the sub-packages were not being included, but with the include statement it worked as intended and bundled the sub-packages.

Do you mind running that by the CI?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure. But as it is changing the behavior, even if it works, I would like it in a separate PR :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well what you used doesn't match the original either, since you're missing the exclude so I'd just switch to the new style using include and you can leave off the namespace disabling or turn it off if you really prefer it to be off. I just don't think it needs to be off.

3 changes: 0 additions & 3 deletions setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
[metadata]
license_files = LICENSE.md

[tool:pytest]
addopts=--tb=short --strict-markers -ra
testspath = tests
Expand Down
125 changes: 0 additions & 125 deletions setup.py
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ envlist =
base
dist
docs
isolated_build = true

[testenv]
commands = python -W error::DeprecationWarning -W error::PendingDeprecationWarning runtests.py --coverage {posargs}
Expand Down
Loading