summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorClaude Paroz <claude@2xlibre.net>2024-06-24 20:34:43 +0200
committernessita <124304+nessita@users.noreply.github.com>2025-05-05 11:46:49 -0300
commitafe52d89c4f42870622a4bb161ab5f4d4913aac5 (patch)
tree7ae079c42c7e6cb15549851a5d606afc54b0b9ed /docs
parent35c34ed2d0039db98a871da300531514bb0cbac0 (diff)
[4.2.x] Migrated setuptools configuration to pyproject.toml.
This branch migrates setuptools configuration from setup.py/setup.cfg to pyproject.toml. In order to ensure that the generated binary files have consistent casing (both the tarball and the wheel), setuptools version is limited to ">=61.0.0,<69.3.0". Configuration for flake8 was moved to a dedicated .flake8 file since it cannot be configured via pyproject.toml. Also, __pycache__ exclusion was removed from MANIFEST and the extras/Makefile was replaced with a simpler build command. Co-authored-by: Nick Pope <nick@nickpope.me.uk> Backport of 4686541691dbe986f58ac87630c3b7a04db4ff93 from main.
Diffstat (limited to 'docs')
-rw-r--r--docs/internals/contributing/writing-code/coding-style.txt2
-rw-r--r--docs/internals/howto-release-django.txt18
-rw-r--r--docs/topics/auth/passwords.txt4
3 files changed, 15 insertions, 9 deletions
diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt
index d227e04ba0..0a023ed392 100644
--- a/docs/internals/contributing/writing-code/coding-style.txt
+++ b/docs/internals/contributing/writing-code/coding-style.txt
@@ -46,7 +46,7 @@ Python style
* Unless otherwise specified, follow :pep:`8`.
Use :pypi:`flake8` to check for problems in this area. Note that our
- ``setup.cfg`` file contains some excluded files (deprecated modules we don't
+ ``.flake8`` file contains some excluded files (deprecated modules we don't
care about cleaning up and some third-party code that Django vendors) as well
as some excluded errors that we don't consider as gross violations. Remember
that :pep:`8` is only a guide, so respect the style of the surrounding code
diff --git a/docs/internals/howto-release-django.txt b/docs/internals/howto-release-django.txt
index 5c2d0b7451..ba70921ad2 100644
--- a/docs/internals/howto-release-django.txt
+++ b/docs/internals/howto-release-django.txt
@@ -58,7 +58,7 @@ You'll need a few things before getting started:
.. code-block:: shell
- $ python -m pip install wheel twine
+ $ python -m pip install build twine
* Access to Django's record on PyPI. Create a file with your credentials:
@@ -222,9 +222,15 @@ OK, this is the fun part, where we actually push out a release!
Please see `notes on setting the VERSION tuple`_ below for details
on ``VERSION``.
-#. If this is a pre-release package, update the "Development Status" trove
- classifier in ``setup.cfg`` to reflect this. Otherwise, make sure the
- classifier is set to ``Development Status :: 5 - Production/Stable``.
+ #. If this is a pre-release package also update the "Development Status"
+ trove classifier in ``pyproject.toml`` to reflect this. An ``rc``
+ pre-release should not change the trove classifier (:commit:`example
+ commit for alpha release <eeeacc52a967234e920c001b7908c4acdfd7a848>`,
+ :commit:`example commit for beta release
+ <25fec8940b24107e21314ab6616e18ce8dec1c1c>`).
+
+ #. Otherwise, make sure the classifier is set to
+ ``Development Status :: 5 - Production/Stable``.
#. Tag the release using ``git tag``. For example:
@@ -238,8 +244,8 @@ OK, this is the fun part, where we actually push out a release!
#. Make sure you have an absolutely clean tree by running ``git clean -dfx``.
-#. Run ``make -f extras/Makefile`` to generate the release packages. This will
- create the release packages in a ``dist/`` directory.
+#. Run ``python -m build`` to generate the release packages. This will create
+ the release packages in a ``dist/`` directory.
#. Generate the hashes of the release packages:
diff --git a/docs/topics/auth/passwords.txt b/docs/topics/auth/passwords.txt
index b7b2dd4f7a..636e9a2c32 100644
--- a/docs/topics/auth/passwords.txt
+++ b/docs/topics/auth/passwords.txt
@@ -97,7 +97,7 @@ To use Argon2id as your default storage algorithm, do the following:
#. Install the :pypi:`argon2-cffi` package. This can be done by running
``python -m pip install django[argon2]``, which is equivalent to
``python -m pip install argon2-cffi`` (along with any version requirement
- from Django's ``setup.cfg``).
+ from Django's ``pyproject.toml``).
#. Modify :setting:`PASSWORD_HASHERS` to list ``Argon2PasswordHasher`` first.
That is, in your settings file, you'd put::
@@ -128,7 +128,7 @@ To use Bcrypt as your default storage algorithm, do the following:
#. Install the :pypi:`bcrypt` package. This can be done by running
``python -m pip install django[bcrypt]``, which is equivalent to
``python -m pip install bcrypt`` (along with any version requirement from
- Django's ``setup.cfg``).
+ Django's ``pyproject.toml``).
#. Modify :setting:`PASSWORD_HASHERS` to list ``BCryptSHA256PasswordHasher``
first. That is, in your settings file, you'd put::