The Web framework for perfectionists with deadlines.
Find a file
Natalia 93fd01d641 [5.2.x] Added timeout-minutes directive to all GitHub Actions workflows.
GitHub Actions defaults to a 360-minute (6-hour) timeout. We've had jobs
hang due to issues in the parallel test runner, causing them to run for
the full 6 hours. This wastes resources and negatively impacts CI
availability, so explicit timeouts have been added to prevent
long-running hangs.

Backport of e48527f91d from main.
2025-11-26 08:03:38 -05:00
.github [5.2.x] Added timeout-minutes directive to all GitHub Actions workflows. 2025-11-26 08:03:38 -05:00
.tx Updated Transifex configuration for new CLI. 2023-04-02 09:54:33 +02:00
django [5.2.x] Fixed #36751 -- Fixed empty filtered aggregation crash over annotated queryset. 2025-11-24 12:15:48 +01:00
docs [5.2.x] Added stub release notes and release date for 5.2.9, 5.1.15, and 4.2.27. 2025-11-25 15:17:14 -03:00
extras Migrated setuptools configuration to pyproject.toml. 2024-06-24 15:34:43 -03:00
js_tests [5.2.x] Fixed #36423 -- Prevented filter_horizontal buttons from intercepting form submission. 2025-06-02 22:26:36 -03:00
scripts [5.2.x] Added scripts for building and releasing Django artifacts. 2025-11-21 15:38:20 -03:00
tests [5.2.x] Fixed #36751 -- Fixed empty filtered aggregation crash over annotated queryset. 2025-11-24 12:15:48 +01:00
.editorconfig Refs #33476 -- Adjusted docs and config files for Black. 2022-02-07 20:36:04 +01:00
.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 Fixed #19670 -- Applied CachedFilesMixin patterns to specific extensions 2016-03-30 14:34:41 +02:00
.gitignore Refs #34043 -- Added --screenshots option to runtests.py and selenium tests. 2023-10-18 06:14:40 +02:00
.pre-commit-config.yaml [5.2.x] Added GitHub Actions linter (zizmor). 2025-11-21 14:43:27 -05:00
.readthedocs.yml Upgraded to Python 3.12, Ubuntu 24.04, and enabled fail_on_warning for docs builds. 2024-11-27 15:20:49 -03:00
AUTHORS [5.2.x] Fixed #36681 -- Removed English pluralization bias from example in docs/topics/i18n/translation.txt. 2025-10-27 14:43:40 -04:00
CONTRIBUTING.rst
eslint.config.mjs Migrated to ESLint 9+. 2024-05-06 11:42:37 +02:00
Gruntfile.js Refs #31265 -- Updated .eslintignore to match eslint tests 2020-12-23 11:14:48 +01:00
INSTALL Fixed #34233 -- Dropped support for Python 3.8 and 3.9. 2023-01-18 09:46:01 +01:00
LICENSE
LICENSE.python Removed current year from Python license file. 2025-01-02 11:50:14 -03:00
MANIFEST.in [5.2.x] Skipped scripts/ folder from built release artifacts. 2025-11-21 15:38:20 -03:00
package.json Bumped versions in pre-commit and npm configurations. 2024-10-08 17:58:53 -03:00
pyproject.toml [5.2.x] Refs #35844 -- Doc'd Python 3.14 compatibility. 2025-10-17 20:05:19 +02:00
README.rst [5.2.x] Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:16:20 +01:00
tox.ini [5.2.x] Added GitHub Actions linter (zizmor). 2025-11-21 14:43:27 -05:00
zizmor.yml [5.2.x] Configured dangerous-triggers zizmor rule. 2025-11-21 14:51:46 -05:00

======
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 Discord community <https://chat.djangoproject.com>`_.

* 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/