Go to file
ssanger 08c0c42139 [5.1.x] Fixed #35863 -- Replaced bold text with heading level 3 in new contributors docs.
This improves accessibility for screen reader users, see WCAG SC 1.3.1 Info and Relationships:
https://www.w3.org/WAI/WCAG22/Understanding/info-and-relationships.html

Backport of c4c076223e from main.
2024-11-06 17:05:37 +01:00
.github [5.1.x] Added GitHub Action workflow to test all Python versions listed in the project config file. 2024-10-09 10:22:07 -03:00
.tx Updated Transifex configuration for new CLI. 2023-04-02 09:54:33 +02:00
django [5.1.x] Post-release version bump. 2024-11-05 06:11:20 +01:00
docs [5.1.x] Fixed #35863 -- Replaced bold text with heading level 3 in new contributors docs. 2024-11-06 17:05:37 +01:00
extras [5.1.x] Migrated setuptools configuration to pyproject.toml. 2024-06-24 22:31:17 -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 [5.1.x] Fixed #35876 -- Displayed non-ASCII fieldset names when rendering ModelAdmin.fieldsets. 2024-10-31 06:41:10 +01:00
.editorconfig Refs #33476 -- Adjusted docs and config files for Black. 2022-02-07 20:36:04 +01:00
.flake8 [5.1.x] Migrated setuptools configuration to pyproject.toml. 2024-06-24 22:31:17 -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 Configured Read The Docs to build all formats. 2021-11-18 12:21:00 +01:00
AUTHORS [5.1.x] Fixed #35606, Refs #34045 -- Fixed rendering of ModelAdmin.action_checkbox for models with a __html__ method. 2024-07-18 08:12:36 +02:00
CONTRIBUTING.rst
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 Updated Python license for 2024. 2024-01-27 11:54:02 +01:00
MANIFEST.in [5.1.x] Migrated setuptools configuration to pyproject.toml. 2024-06-24 22:31:17 -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 [5.1.x] Refs #34900 -- Doc'd Python 3.13 compatibility. 2024-10-09 09:56:42 +02:00
tox.ini [5.1.x] Refs #34900 -- Doc'd Python 3.13 compatibility. 2024-10-09 09:56:42 +02: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/