Go to file
Claude Paroz 4686541691
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>
2024-06-24 15:34:43 -03:00
.github Fixed #35479 -- Dropped support for PostgreSQL 13 and PostGIS 3.0. 2024-05-27 09:49:25 +02:00
.tx Updated Transifex configuration for new CLI. 2023-04-02 09:54:33 +02:00
django Fixed #35545, Refs #32833 -- Fixed ContentTypeManager.get_for_models() crash in CreateModel migrations. 2024-06-24 10:20:11 +02:00
docs Migrated setuptools configuration to pyproject.toml. 2024-06-24 15:34:43 -03:00
extras Migrated setuptools configuration to pyproject.toml. 2024-06-24 15:34:43 -03:00
js_tests Refs #35189 -- Removed no longer necessary JavaScript file collapse.js. 2024-05-22 00:13:55 -03:00
scripts Removed obsolete rpm-related install code. 2024-01-05 06:03:19 +01:00
tests Fixed #35545, Refs #32833 -- Fixed ContentTypeManager.get_for_models() crash in CreateModel migrations. 2024-06-24 10:20:11 +02:00
.editorconfig
.flake8 Migrated setuptools configuration to pyproject.toml. 2024-06-24 15:34:43 -03:00
.git-blame-ignore-revs Ignored 305757aec1 formatting changes in git blame. 2024-01-26 12:46:08 +01:00
.gitattributes
.gitignore Refs #34043 -- Added --screenshots option to runtests.py and selenium tests. 2023-10-18 06:14:40 +02:00
.pre-commit-config.yaml Matched blacken-docs config between ci and pre-commit. 2024-05-08 08:04:06 +02:00
.readthedocs.yml
AUTHORS Fixed #35417 -- Updated BaseContext.new() with values to create a context that can be flattened. 2024-06-13 14:22:40 +02:00
CONTRIBUTING.rst
Gruntfile.js
INSTALL Fixed #34233 -- Dropped support for Python 3.8 and 3.9. 2023-01-18 09:46:01 +01:00
LICENSE
LICENSE.python Updated Python license for 2024. 2024-01-27 11:54:02 +01:00
MANIFEST.in Migrated setuptools configuration to pyproject.toml. 2024-06-24 15:34:43 -03:00
README.rst Fixed #34678 -- Added Django Forum and Discord server to README.rst. 2023-06-26 05:28:28 +02:00
eslint.config.mjs Migrated to ESLint 9+. 2024-05-06 11:42:37 +02:00
package.json Migrated to ESLint 9+. 2024-05-06 11:42:37 +02:00
pyproject.toml Migrated setuptools configuration to pyproject.toml. 2024-06-24 15:34:43 -03:00
tox.ini Refs #34986 -- Added PyPy to tox.ini. 2023-12-06 09:28:14 +01:00

README.rst

======
Django
======

Django is a high-level Python web framework that encourages rapid development
and clean, pragmatic design. Thanks for checking it out.

All documentation is in the "``docs``" directory and online at
https://docs.djangoproject.com/en/stable/. If you're just getting started,
here's how we recommend you read the docs:

* First, read ``docs/intro/install.txt`` for instructions on installing Django.

* Next, work through the tutorials in order (``docs/intro/tutorial01.txt``,
  ``docs/intro/tutorial02.txt``, etc.).

* If you want to set up an actual deployment server, read
  ``docs/howto/deployment/index.txt`` for instructions.

* You'll probably want to read through the topical guides (in ``docs/topics``)
  next; from there you can jump to the HOWTOs (in ``docs/howto``) for specific
  problems, and check out the reference (``docs/ref``) for gory details.

* See ``docs/README`` for instructions on building an HTML version of the docs.

Docs are updated rigorously. If you find any problems in the docs, or think
they should be clarified in any way, please take 30 seconds to fill out a
ticket here: https://code.djangoproject.com/newticket

To get more help:

* Join the ``#django`` channel on ``irc.libera.chat``. Lots of helpful people
  hang out there. `Webchat is available <https://web.libera.chat/#django>`_.

* Join the django-users mailing list, or read the archives, at
  https://groups.google.com/group/django-users.

* Join the `Django Discord community <https://discord.gg/xcRH6mN4fa>`_.

* Join the community on the `Django Forum <https://forum.djangoproject.com/>`_.

To contribute to Django:

* Check out https://docs.djangoproject.com/en/dev/internals/contributing/ for
  information about getting involved.

To run Django's test suite:

* Follow the instructions in the "Unit tests" section of
  ``docs/internals/contributing/writing-code/unit-tests.txt``, published online at
  https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/unit-tests/#running-the-unit-tests

Supporting the Development of Django
====================================

Django's development depends on your contributions.

If you depend on Django, remember to support the Django Software Foundation: https://www.djangoproject.com/fundraising/