1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
Go to file
Mariusz Felisiak 43aa0c103b [5.0.x] Removed outdated note about limitations in Clickjacking protection.
There is no need to list old browser versions or point users to
workarounds.
Backport of f302343380 from main.
2024-07-04 18:13:25 -03:00
.github [5.0.x] Used Node.js 20 for GitHub actions. 2023-10-03 13:43:40 +02:00
.tx Updated Transifex configuration for new CLI. 2023-04-02 09:54:33 +02:00
django [5.0.x] Fixed #35560 -- Made Model.full_clean() ignore GeneratedFields for constraints. 2024-07-04 11:49:27 +02:00
docs [5.0.x] Removed outdated note about limitations in Clickjacking protection. 2024-07-04 18:13:25 -03:00
extras Refs #23433 -- Removed django-admin.py entry point per deprecation timeline. 2021-01-14 17:50:04 +01:00
js_tests [5.0.x] Fixed #34995 -- Improved position of related widget's add link on admin pages on small screens. 2023-11-30 17:09:55 -03:00
scripts Refs #33476 -- Reformatted code with Black. 2022-02-07 20:37:05 +01:00
tests [5.0.x] Fixed #35560 -- Made Model.full_clean() ignore GeneratedFields for constraints. 2024-07-04 11:49:27 +02:00
.editorconfig Refs #33476 -- Adjusted docs and config files for Black. 2022-02-07 20:36:04 +01:00
.eslintignore Fixed #34343 -- Moved built-in templates to filesystem. 2023-02-17 09:50:50 +01:00
.eslintrc Enabled ESLint's "eqeqeq" rule. 2020-05-18 07:42:51 +02:00
.git-blame-ignore-revs [5.0.x] Ignored 0379e7532f formatting changes in git blame. 2024-01-26 12:59:07 +01:00
.gitattributes Fixed #19670 -- Applied CachedFilesMixin patterns to specific extensions 2016-03-30 14:34:41 +02:00
.gitignore Restored multiprocessing concurrency on coverage.py settings 2023-04-27 17:02:55 -03:00
.pre-commit-config.yaml [5.0.x] Applied Black's 2024 stable style. 2024-01-26 12:55:56 +01:00
.readthedocs.yml Configured Read The Docs to build all formats. 2021-11-18 12:21:00 +01:00
AUTHORS [5.0.x] Fixed #23790 -- Warned about renaming AppConfig.label in docs/ref/applications.txt. 2024-07-01 21:53:50 -03:00
CONTRIBUTING.rst Added link to the code of conduct from contributing guides. 2015-04-17 18:12:41 -04: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 Whitespace cleanup. 2013-10-10 16:49:20 -04:00
LICENSE.python Updated Python license for 2022. 2022-01-12 11:21:51 +01:00
MANIFEST.in Fixed #34248 -- Added tox.ini to MANIFEST.in. 2023-02-09 20:47:34 +01:00
package.json [5.0.x] Bumped versions in pre-commit and npm configurations. 2024-01-26 12:51:24 +01:00
pyproject.toml Refs #34233 -- Updated black target-version to Python 3.10. 2023-06-11 14:57:13 +02:00
README.rst Fixed #34678 -- Added Django Forum and Discord server to README.rst. 2023-06-26 05:28:28 +02:00
setup.cfg [5.0.x] Updated asgiref dependency for 5.0 release series. 2023-12-28 09:46:34 +01:00
setup.py Refs #33476 -- Reformatted code with Black. 2022-02-07 20:37:05 +01:00
tox.ini [5.0.x] Refs #34118 -- Added Python 3.12 to classifiers and tox.ini. 2023-11-19 16:32:55 +01: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/