This document will get you up and running with Django.
\nDjango is a Python web framework. See What Python version can I use with Django? for\ndetails.
\nGet the latest version of Python at https://www.python.org/downloads/ or with\nyour operating system’s package manager.
\n\nmod_wsgiLink to this heading#If you just want to experiment with Django, skip ahead to the next\nsection; Django includes a lightweight web server you can use for\ntesting, so you won’t need to set up Apache until you’re ready to\ndeploy Django in production.
\nIf you want to use Django on a production site, use Apache with\nmod_wsgi. mod_wsgi operates in one of two modes: embedded\nmode or daemon mode. In embedded mode, mod_wsgi is similar to\nmod_perl – it embeds Python within Apache and loads Python code into\nmemory when the server starts. Code stays in memory throughout the\nlife of an Apache process, which leads to significant performance\ngains over other server arrangements. In daemon mode, mod_wsgi spawns\nan independent daemon process that handles requests. The daemon\nprocess can run as a different user than the web server, possibly\nleading to improved security. The daemon process can be restarted\nwithout restarting the entire Apache web server, possibly making\nrefreshing your codebase more seamless. Consult the mod_wsgi\ndocumentation to determine which mode is right for your setup. Make\nsure you have Apache installed with the mod_wsgi module activated.\nDjango will work with any version of Apache that supports mod_wsgi.
\nSee How to use Django with mod_wsgi\nfor information on how to configure mod_wsgi once you have it\ninstalled.
\nIf you can’t use mod_wsgi for some reason, fear not: Django supports many other\ndeployment options. One is uWSGI; it works\nvery well with nginx. Additionally, Django follows the WSGI spec\n(PEP 3333), which allows it to run on a variety of server platforms.
\nIf you plan to use Django’s database API functionality, you’ll need to make\nsure a database server is running. Django supports many different database\nservers and is officially supported with PostgreSQL, MariaDB, MySQL, Oracle\nand SQLite.
\nIf you are developing a small project or something you don’t plan to deploy in\na production environment, SQLite is generally the best option as it doesn’t\nrequire running a separate server. However, SQLite has many differences from\nother databases, so if you are working on something substantial, it’s\nrecommended to develop with the same database that you plan on using in\nproduction.
\nIn addition to the officially supported databases, there are backends\nprovided by 3rd parties that allow you to use other\ndatabases with Django.
\nIn addition to a database backend, you’ll need to make sure your Python\ndatabase bindings are installed.
\nIf you’re using PostgreSQL, you’ll need the psycopg2 package. Refer to the\nPostgreSQL notes for further details.
If you’re using MySQL or MariaDB, you’ll need a DB API driver like mysqlclient. See notes for the MySQL\nbackend for details.
If you’re using SQLite you might want to read the SQLite backend notes.
If you’re using Oracle, you’ll need a copy of cx_Oracle, but please\nread the notes for the Oracle backend for details\nregarding supported versions of both Oracle and cx_Oracle.
If you’re using an unofficial 3rd party backend, please consult the\ndocumentation provided for any additional requirements.
If you plan to use Django’s manage.py migrate command to automatically\ncreate database tables for your models (after first installing Django and\ncreating a project), you’ll need to ensure that Django has permission to create\nand alter tables in the database you’re using; if you plan to manually create\nthe tables, you can grant Django SELECT, INSERT, UPDATE and\nDELETE permissions. After creating a database user with these permissions,\nyou’ll specify the details in your project’s settings file, see\nDATABASES for details.
If you’re using Django’s testing framework to test\ndatabase queries, Django will need permission to create a test database.
\nInstallation instructions are slightly different depending on whether you’re\ninstalling a distribution-specific package, downloading the latest official\nrelease, or fetching the latest development version.
\npipLink to this heading#This is the recommended way to install Django.
\nInstall pip. The easiest is to use the standalone pip installer. If your\ndistribution already has pip installed, you might need to update it if\nit’s outdated. If it’s outdated, you’ll know because installation won’t\nwork.
Take a look at venv. This tool provides\nisolated Python environments, which are more practical than installing\npackages systemwide. It also allows installing packages without\nadministrator privileges. The contributing tutorial walks through how to create a virtual environment.
After you’ve created and activated a virtual environment, enter the command:
\nLinux / macOS
$ python -m pip install Django\nWindows
...\\> py -m pip install Django\nCheck the distribution specific notes to see if\nyour platform/distribution provides official Django packages/installers.\nDistribution-provided packages will typically allow for automatic installation\nof dependencies and supported upgrade paths; however, these packages will rarely\ncontain the latest release of Django.
\nIf you’d like to be able to update your Django code occasionally with the\nlatest bug fixes and improvements, follow these instructions:
\nMake sure that you have Git installed and that you can run its commands\nfrom a shell. (Enter git help at a shell prompt to test this.)
Check out Django’s main development branch like so:
\nLinux / macOS
$ git clone https://github.com/django/django.git\nWindows
...\\> git clone https://github.com/django/django.git\nThis will create a directory django in your current directory.
Make sure that the Python interpreter can load Django’s code. The most\nconvenient way to do this is to use a virtual environment and pip. The\ncontributing tutorial walks through how to\ncreate a virtual environment.
After setting up and activating the virtual environment, run the following\ncommand:
\nLinux / macOS
$ python -m pip install -e django/\nWindows
...\\> py -m pip install -e django\\\nThis will make Django’s code importable, and will also make the\ndjango-admin utility command available. In other words, you’re all\nset!
When you want to update your copy of the Django source code, run the command\ngit pull from within the django directory. When you do this, Git will\ndownload any changes.