1
0
mirror of https://github.com/django/django.git synced 2025-01-09 18:06:34 +00:00
Go to file
Sarah Boyce 8d81c4730f [5.1.x] Fixed #35999 -- Removed #django IRC channel references where appropriate.
Some references are replaced with links to the Django Discord server.

Backport of 15e207ce80 from main.
2025-01-08 10:29:52 +01:00
.github [5.1.x] Upgraded to Python 3.12, Ubuntu 24.04, and enabled fail_on_warning for docs builds. 2024-11-27 15:23:02 -03:00
.tx
django [5.1.x] Fixed #34856 -- Fixed references to index_together in historical migrations. 2024-12-17 10:01:51 +01:00
docs [5.1.x] Fixed #35999 -- Removed #django IRC channel references where appropriate. 2025-01-08 10:29:52 +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
tests [5.1.x] Fixed #34856 -- Fixed references to index_together in historical migrations. 2024-12-17 10:01:51 +01:00
.editorconfig
.flake8 [5.1.x] Migrated setuptools configuration to pyproject.toml. 2024-06-24 22:31:17 -03:00
.git-blame-ignore-revs
.gitattributes
.gitignore
.pre-commit-config.yaml Matched blacken-docs config between ci and pre-commit. 2024-05-08 08:04:06 +02:00
.readthedocs.yml [5.1.x] Upgraded to Python 3.12, Ubuntu 24.04, and enabled fail_on_warning for docs builds. 2024-11-27 15:23:02 -03: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
eslint.config.mjs
Gruntfile.js
INSTALL Fixed #34233 -- Dropped support for Python 3.8 and 3.9. 2023-01-18 09:46:01 +01:00
LICENSE Whitespace cleanup. 2013-10-10 16:49:20 -04:00
LICENSE.python
MANIFEST.in [5.1.x] Migrated setuptools configuration to pyproject.toml. 2024-06-24 22:31:17 -03:00
package.json
pyproject.toml [5.1.x] Refs #34900 -- Doc'd Python 3.13 compatibility. 2024-10-09 09:56:42 +02:00
README.rst
tox.ini [5.1.x] Refs #34900 -- Doc'd Python 3.13 compatibility. 2024-10-09 09:56:42 +02: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-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/