<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The Django source code repository — Django 1.8.19 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="top" title="Django 1.8.19 documentation" href="../contents.html" />
<link rel="up" title="Django internals" href="index.html" />
<link rel="next" title="How is Django Formed?" href="howto-release-django.html" />
<link rel="prev" title="Django Deprecation Timeline" href="deprecation.html" />
<script type="text/javascript" src="../templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "../ref/templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body role="document">
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../index.html">Django 1.8.19 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="../index.html">Home</a> |
<a title="Table of contents" href="../contents.html">Table of contents</a> |
<a title="Global index" href="../genindex.html">Index</a> |
<a title="Module index" href="../py-modindex.html">Modules</a>
</div>
<div class="nav">
« <a href="deprecation.html" title="Django Deprecation Timeline">previous</a>
|
<a href="index.html" title="Django internals" accesskey="U">up</a>
|
<a href="howto-release-django.html" title="How is Django Formed?">next</a> »</div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="internals-git">
<div class="section" id="s-the-django-source-code-repository">
<span id="the-django-source-code-repository"></span><h1>The Django source code repository<a class="headerlink" href="#the-django-source-code-repository" title="Permalink to this headline">¶</a></h1>
<p>When deploying a Django application into a real production environment, you
will almost always want to use <a class="reference external" href="https://www.djangoproject.com/download/">an official packaged release of Django</a>.</p>
<p>However, if you’d like to try out in-development code from an upcoming release
or contribute to the development of Django, you’ll need to obtain a clone of
Django’s source code repository.</p>
<p>This document covers the way the code repository is laid out and how to work
with and find things in it.</p>
<div class="section" id="s-high-level-overview">
<span id="high-level-overview"></span><h2>High-level overview<a class="headerlink" href="#high-level-overview" title="Permalink to this headline">¶</a></h2>
<p>The Django source code repository uses <a class="reference external" href="http://git-scm.com/">Git</a> to track changes to the code
over time, so you’ll need a copy of the Git client (a program called <code class="docutils literal"><span class="pre">git</span></code>)
on your computer, and you’ll want to familiarize yourself with the basics of
how Git works.</p>
<p>Git’s web site offers downloads for various operating systems. The site also
contains vast amounts of <a class="reference external" href="http://git-scm.com/documentation">documentation</a>.</p>
<p>The Django Git repository is located online at <a class="reference external" href="https://github.com/django/django">github.com/django/django</a>. It contains the full source code for all
Django releases, which you can browse online.</p>
<p>The Git repository includes several <a class="reference external" href="https://github.com/django/django/branches">branches</a>:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">master</span></code> contains the main in-development code which will become
the next packaged release of Django. This is where most development
activity is focused.</li>
<li><code class="docutils literal"><span class="pre">stable/A.B.x</span></code> are the branches where release preparation work happens.
They are also used for support and bugfix releases which occur as necessary
after the initial release of a major or minor version.</li>
<li><code class="docutils literal"><span class="pre">soc20XX/<project></span></code> branches were used by students who worked on Django
during the 2009 and 2010 Google Summer of Code programs.</li>
<li><code class="docutils literal"><span class="pre">attic/<project></span></code> branches were used to develop major or experimental new
features without affecting the rest of Django’s code.</li>
</ul>
<p>The Git repository also contains <a class="reference external" href="https://github.com/django/django/tags">tags</a>. These are the exact revisions from
which packaged Django releases were produced, since version 1.0.</p>
<p>The source code for the <a class="reference external" href="https://www.djangoproject.com/">Djangoproject.com</a> web
site can be found at <a class="reference external" href="https://github.com/django/djangoproject.com">github.com/django/djangoproject.com</a>.</p>
</div>
<div class="section" id="s-the-master-branch">
<span id="the-master-branch"></span><h2>The master branch<a class="headerlink" href="#the-master-branch" title="Permalink to this headline">¶</a></h2>
<p>If you’d like to try out the in-development code for the next release of
Django, or if you’d like to contribute to Django by fixing bugs or developing
new features, you’ll want to get the code from the master branch.</p>
<p>Note that this will get <em>all</em> of Django: in addition to the top-level
<code class="docutils literal"><span class="pre">django</span></code> module containing Python code, you’ll also get a copy of Django’s
documentation, test suite, packaging scripts and other miscellaneous bits.
Django’s code will be present in your clone as a directory named
<code class="docutils literal"><span class="pre">django</span></code>.</p>
<p>To try out the in-development code with your own applications, simply place
the directory containing your clone on your Python import path. Then
<code class="docutils literal"><span class="pre">import</span></code> statements which look for Django will find the <code class="docutils literal"><span class="pre">django</span></code> module
within your clone.</p>
<p>If you’re going to be working on Django’s code (say, to fix a bug or
develop a new feature), you can probably stop reading here and move
over to <a class="reference internal" href="contributing/index.html"><span class="doc">the documentation for contributing to Django</span></a>, which covers things like the preferred
coding style and how to generate and submit a patch.</p>
</div>
<div class="section" id="s-other-branches">
<span id="other-branches"></span><h2>Other branches<a class="headerlink" href="#other-branches" title="Permalink to this headline">¶</a></h2>
<p>Django uses branches to prepare for releases of Django (whether they be
<a class="reference internal" href="release-process.html#term-major-release"><span class="xref std std-term">major</span></a> or <a class="reference internal" href="release-process.html#term-minor-release"><span class="xref std std-term">minor</span></a>).</p>
<p>In the past when Django was hosted on Subversion, branches were also used for
feature development. Now Django is hosted on Git and feature development is
done on contributor’s forks, but the Subversion feature branches remain in Git
for historical reference.</p>
<div class="section" id="s-stable-branches">
<span id="stable-branches"></span><h3>Stable branches<a class="headerlink" href="#stable-branches" title="Permalink to this headline">¶</a></h3>
<p>These branches can be found in the repository as <code class="docutils literal"><span class="pre">stable/A.B.x</span></code>
branches and will be created right after the first alpha is tagged.</p>
<p>For example, immediately after <em>Django 1.5 alpha 1</em> was tagged, the branch
<code class="docutils literal"><span class="pre">stable/1.5.x</span></code> was created and all further work on preparing the code for the
final 1.5 release was done there.</p>
<p>These branches also provide limited bugfix support for the most recent released
version of Django and security support for the two most recently-released
versions of Django.</p>
<p>For example, after the release of Django 1.5, the branch <code class="docutils literal"><span class="pre">stable/1.5.x</span></code>
receives only fixes for security and critical stability bugs, which are
eventually released as Django 1.5.1 and so on, <code class="docutils literal"><span class="pre">stable/1.4.x</span></code> receives only
security fixes, and <code class="docutils literal"><span class="pre">stable/1.3.x</span></code> no longer receives any updates.</p>
<div class="admonition-historical-information admonition">
<p class="first admonition-title">Historical information</p>
<p>This policy for handling <code class="docutils literal"><span class="pre">stable/A.B.x</span></code> branches was adopted starting
with the Django 1.5 release cycle.</p>
<p>Previously, these branches weren’t created until right after the releases
and the stabilization work occurred on the main repository branch. Thus,
no new features development work for the next release of Django could be
committed until the final release happened.</p>
<p class="last">For example, shortly after the release of Django 1.3 the branch
<code class="docutils literal"><span class="pre">stable/1.3.x</span></code> was created. Official support for that release has expired,
and so it no longer receives direct maintenance from the Django project.
However, that and all other similarly named branches continue to exist and
interested community members have occasionally used them to provide
unofficial support for old Django releases.</p>
</div>
</div>
<div class="section" id="s-feature-development-branches">
<span id="feature-development-branches"></span><h3>Feature-development branches<a class="headerlink" href="#feature-development-branches" title="Permalink to this headline">¶</a></h3>
<div class="admonition-historical-information admonition">
<p class="first admonition-title">Historical information</p>
<p>Since Django moved to Git in 2012, anyone can clone the repository and
create their own branches, alleviating the need for official branches in
the source code repository.</p>
<p class="last">The following section is mostly useful if you’re exploring the repository’s
history, for example if you’re trying to understand how some features were
designed.</p>
</div>
<p>Feature-development branches tend by their nature to be temporary. Some
produce successful features which are merged back into Django’s master to
become part of an official release, but others do not; in either case there
comes a time when the branch is no longer being actively worked on by any
developer. At this point the branch is considered closed.</p>
<p>Unfortunately, Django used to be maintained with the Subversion revision
control system, that has no standard way of indicating this. As a workaround,
branches of Django which are closed and no longer maintained were moved into
<code class="docutils literal"><span class="pre">attic</span></code>.</p>
<p>For reference, the following are branches whose code eventually became
part of Django itself, and so are no longer separately maintained:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">boulder-oracle-sprint</span></code>: Added support for Oracle databases to
Django’s object-relational mapper. This has been part of Django
since the 1.0 release.</li>
<li><code class="docutils literal"><span class="pre">gis</span></code>: Added support for geographic/spatial queries to Django’s
object-relational mapper. This has been part of Django since the 1.0
release, as the bundled application <code class="docutils literal"><span class="pre">django.contrib.gis</span></code>.</li>
<li><code class="docutils literal"><span class="pre">i18n</span></code>: Added <a class="reference internal" href="../topics/i18n/index.html"><span class="doc">internationalization support</span></a> to
Django. This has been part of Django since the 0.90 release.</li>
<li><code class="docutils literal"><span class="pre">magic-removal</span></code>: A major refactoring of both the internals and
public APIs of Django’s object-relational mapper. This has been part
of Django since the 0.95 release.</li>
<li><code class="docutils literal"><span class="pre">multi-auth</span></code>: A refactoring of <a class="reference internal" href="../topics/auth/index.html"><span class="doc">Django’s bundled
authentication framework</span></a> which added support for
<a class="reference internal" href="../topics/auth/customizing.html#authentication-backends"><span class="std std-ref">authentication backends</span></a>. This has
been part of Django since the 0.95 release.</li>
<li><code class="docutils literal"><span class="pre">new-admin</span></code>: A refactoring of <a class="reference internal" href="../ref/contrib/admin/index.html"><span class="doc">Django’s bundled
administrative application</span></a>. This became part of
Django as of the 0.91 release, but was superseded by another
refactoring (see next listing) prior to the Django 1.0 release.</li>
<li><code class="docutils literal"><span class="pre">newforms-admin</span></code>: The second refactoring of Django’s bundled
administrative application. This became part of Django as of the 1.0
release, and is the basis of the current incarnation of
<code class="docutils literal"><span class="pre">django.contrib.admin</span></code>.</li>
<li><code class="docutils literal"><span class="pre">queryset-refactor</span></code>: A refactoring of the internals of Django’s
object-relational mapper. This became part of Django as of the 1.0
release.</li>
<li><code class="docutils literal"><span class="pre">unicode</span></code>: A refactoring of Django’s internals to consistently use
Unicode-based strings in most places within Django and Django
applications. This became part of Django as of the 1.0 release.</li>
</ul>
<p>When Django moved from SVN to Git, the information about branch merges wasn’t
preserved in the source code repository. This means that the <code class="docutils literal"><span class="pre">master</span></code> branch
of Django doesn’t contain merge commits for the above branches.</p>
<p>However, this information is <a class="reference external" href="https://github.com/ramiro/django-git-grafts">available as a grafts file</a>. You can restore it
by putting the following lines in <code class="docutils literal"><span class="pre">.git/info/grafts</span></code> in your local clone:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ac64e91a0cadc57f4bc5cd5d66955832320ca7a1</span> <span class="mi">553</span><span class="n">a20075e6991e7a60baee51ea68c8adc520d9a</span> <span class="mi">0</span><span class="n">cb8e31823b2e9f05c4ae868c19f5f38e78a5f2e</span>
<span class="mi">79</span><span class="n">e68c225b926302ebb29c808dda8afa49856f5c</span> <span class="n">d0f57e7c7385a112cb9e19d314352fc5ed5b0747</span> <span class="n">aa239e3e5405933af6a29dac3cf587b59a099927</span>
<span class="mi">5</span><span class="n">cf8f684237ab5addaf3549b2347c3adf107c0a7</span> <span class="n">cb45fd0ae20597306cd1f877efc99d9bd7cbee98</span> <span class="n">e27211a0deae2f1d402537f0ebb64ad4ccf6a4da</span>
<span class="n">f69cf70ed813a8cd7e1f963a14ae39103e8d5265</span> <span class="n">d5dbeaa9be359a4c794885c2e9f1b5a7e5e51fb8</span> <span class="n">d2fcbcf9d76d5bb8a661ee73dae976c74183098b</span>
<span class="n">aab3a418ac9293bb4abd7670f65d930cb0426d58</span> <span class="mi">4</span><span class="n">ea7a11659b8a0ab07b0d2e847975f7324664f10</span> <span class="n">adf4b9311d5d64a2bdd58da50271c121ea22e397</span>
<span class="n">ff60c5f9de3e8690d1e86f3e9e3f7248a15397c8</span> <span class="mi">7</span><span class="n">ef212af149540aa2da577a960d0d87029fd1514</span> <span class="mi">45</span><span class="n">b4288bb66a3cda401b45901e85b645674c3988</span>
<span class="mi">9</span><span class="n">dda4abee1225db7a7b195b84c915fdd141a7260</span> <span class="mi">4</span><span class="n">fe5c9b7ee09dc25921918a6dbb7605edb374bc9</span> <span class="mi">3</span><span class="n">a7c14b583621272d4ef53061287b619ce3c290d</span>
<span class="n">a19ed8aea395e8e07164ff7d85bd7dff2f24edca</span> <span class="n">dc375fb0f3b7fbae740e8cfcd791b8bccb8a4e66</span> <span class="mi">42</span><span class="n">ea7a5ce8aece67d16c6610a49560c1493d4653</span>
<span class="mi">9</span><span class="n">c52d56f6f8a9cdafb231adf9f4110473099c9b5</span> <span class="n">c91a30f00fd182faf8ca5c03cd7dbcf8b735b458</span> <span class="mi">4</span><span class="n">a5c5c78f2ecd4ed8859cd5ac773ff3a01bccf96</span>
<span class="mi">953</span><span class="n">badbea5a04159adbfa970f5805c0232b6a401</span> <span class="mi">4</span><span class="n">c958b15b250866b70ded7d82aa532f1e57f96ae</span> <span class="mi">5664</span><span class="n">a678b29ab04cad425c15b2792f4519f43928</span>
<span class="mi">471596</span><span class="n">fc1afcb9c6258d317c619eaf5fd394e797</span> <span class="mi">4</span><span class="n">e89105d64bb9e04c409139a41e9c7aac263df4c</span> <span class="mi">3</span><span class="n">e9035a9625c8a8a5e88361133e87ce455c4fc13</span>
<span class="mi">9233</span><span class="n">d0426537615e06b78d28010d17d5a66adf44</span> <span class="mi">6632739</span><span class="n">e94c6c38b4c5a86cf5c80c48ae50ac49f</span> <span class="mi">18</span><span class="n">e151bc3f8a85f2766d64262902a9fcad44d937</span>
</pre></div>
</div>
<p>Additionally, the following branches are closed, but their code was
never merged into Django and the features they aimed to implement
were never finished:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">full-history</span></code></li>
<li><code class="docutils literal"><span class="pre">generic-auth</span></code></li>
<li><code class="docutils literal"><span class="pre">multiple-db-support</span></code></li>
<li><code class="docutils literal"><span class="pre">per-object-permissions</span></code></li>
<li><code class="docutils literal"><span class="pre">schema-evolution</span></code></li>
<li><code class="docutils literal"><span class="pre">schema-evolution-ng</span></code></li>
<li><code class="docutils literal"><span class="pre">search-api</span></code></li>
<li><code class="docutils literal"><span class="pre">sqlalchemy</span></code></li>
</ul>
<p>All of the above-mentioned branches now reside in <code class="docutils literal"><span class="pre">attic</span></code>.</p>
<p>Finally, the repository contains <code class="docutils literal"><span class="pre">soc2009/xxx</span></code> and <code class="docutils literal"><span class="pre">soc2010/xxx</span></code> feature
branches, used for Google Summer of Code projects.</p>
</div>
</div>
<div class="section" id="s-id1">
<span id="id1"></span><h2>Tags<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>Each Django release is tagged and signed by a <a class="reference internal" href="roles.html#releasers-list"><span class="std std-ref">releaser</span></a>.</p>
<p>The tags can be found on GitHub’s <a class="reference external" href="https://github.com/django/django/tags">tags</a> page.</p>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">The Django source code repository</a><ul>
<li><a class="reference internal" href="#high-level-overview">High-level overview</a></li>
<li><a class="reference internal" href="#the-master-branch">The master branch</a></li>
<li><a class="reference internal" href="#other-branches">Other branches</a><ul>
<li><a class="reference internal" href="#stable-branches">Stable branches</a></li>
<li><a class="reference internal" href="#feature-development-branches">Feature-development branches</a></li>
</ul>
</li>
<li><a class="reference internal" href="#id1">Tags</a></li>
</ul>
</li>
</ul>
<h3>Browse</h3>
<ul>
<li>Prev: <a href="deprecation.html">Django Deprecation Timeline</a></li>
<li>Next: <a href="howto-release-django.html">How is Django Formed?</a></li>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../index.html">Django 1.8.19 documentation</a>
<ul><li><a href="index.html">Django internals</a>
<ul><li>The Django source code repository</li></ul>
</li></ul>
</li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/internals/git.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<h3>Last update:</h3>
<p class="topless">Mar 10, 2018</p>
</div>
</div>
<div id="ft">
<div class="nav">
« <a href="deprecation.html" title="Django Deprecation Timeline">previous</a>
|
<a href="index.html" title="Django internals" accesskey="U">up</a>
|
<a href="howto-release-django.html" title="How is Django Formed?">next</a> »</div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
65530c6176058f9b54858c3b4f6385e6
>
files
>
652
