Source code to
PostScript JavaScript Python HTML CSS CoffeeScript Other
Switch branches/tags
Nothing to show
Clone or download
timgraham Corrected contenttypes shortcut URL.
Characters were inadvertently removed in
Latest commit f11ae58 Jun 11, 2018
Failed to load latest commit information.
accounts Updated URLpatterns to use path(). Jun 7, 2018
aggregator Updated URLpatterns to use path(). Jun 7, 2018
blog Updated URLpatterns to use path(). Jun 7, 2018
contact Updated URLpatterns to use path(). Jun 7, 2018
dashboard Updated URLpatterns to use path(). Jun 7, 2018
djangoproject Corrected contenttypes shortcut URL. Jun 11, 2018
docs Added multilingual documentation search. Jun 7, 2018
fundraising Updated URLpatterns to use path(). Jun 7, 2018
legacy Updated URLpatterns to use path(). Jun 7, 2018
members Updated URLpatterns to use path(). Jun 7, 2018
releases Updated URLpatterns to use path(). Jun 7, 2018
requirements Updated to Django 2.0.6 Jun 6, 2018
svntogit Updated URLpatterns to use path(). Jun 7, 2018
tracdb Updated URLpatterns to use path(). Jun 7, 2018
.bowerrc Added bower config and use local webfont loader. Jan 2, 2015
.coveragerc Fixed tests and added CI. Jan 22, 2015
.editorconfig Add EditorConfig file Dec 24, 2014
.gitignore Improved Bower integration. Dec 17, 2015
.travis.yml Updated docs search to use PostgreSQL full-text search. Nov 22, 2017
LICENSE Fixed #477 -- Added LICENSE. Jun 12, 2015
Makefile Dropped support for IE8 in CSS. (#718) Nov 8, 2016
Procfile Big refactor that combines www and docs. Dec 30, 2014
README.rst Switched dev TLD to localhost. Mar 29, 2018
bower.json Fixed #181 -- Added copy-to-clipboard feature to code snippets Jul 6, 2016 Big refactor that combines www and docs. Dec 30, 2014
package.json Improved Bower integration. Dec 17, 2015
setup.cfg Added .tox to flake8 ignore. Jul 25, 2016
tox.ini Updated to Python 3.5. Dec 16, 2016

README.rst source code

To run locally, do the usual:

  1. Create a Python 3.5 virtualenv

  2. Install dependencies:

    pip install -r requirements/dev.txt
    npm install

    Alternatively use the make task:

    make install
  3. Make a directory to store the project's data (MEDIA_ROOT, DOC_BUILDS_ROOT, etc.). We'll use ~/.djangoproject for example purposes.

    Create a 'secrets.json' file in a directory named 'conf' in that directory, containing something like:

    { "secret_key": "xyz",
      "superfeedr_creds": ["", "some_string"],
      "db_host": "localhost",
      "db_password": "secret",
      "trac_db_host": "localhost",
      "trac_db_password": "secret" }

    Add export DJANGOPROJECT_DATA_DIR=~/.djangoproject (without the backticks) to your ~/.bashrc (or ~/.zshrc if you're using zsh) file and then run source ~/.bashrc (or source ~/.zshrc) to load the changes.

  4. Create databases:

    createuser -d djangoproject --superuser
    createdb -O djangoproject djangoproject
    createuser -d code.djangoproject --superuser
    createdb -O code.djangoproject code.djangoproject
  5. Setting up database access

    If you are using the default postgres configuration, chances are you will have to give a password for the newly created users in order to be able to use them for Django:

    ALTER USER djangoproject WITH PASSWORD 'secret';
    ALTER USER "code.djangoproject" WITH PASSWORD 'secret';

    (Use the same passwords as the ones you've used in your secrets.json file)

  6. Create tables:

    psql -d code.djangoproject < tracdb/trac.sql
    ./ migrate
  7. Create a superuser:

    ./ createsuperuser
  8. Populate the www and docs hostnames in the django.contrib.sites app:

    ./ loaddata dev_sites
  9. For docs:

    ./ loaddata doc_releases
    ./ update_docs
  10. For dashboard:

    To load the latest dashboard categories and metrics:

    ./ loaddata dashboard_production_metrics

    Alternatively, to load a full set of sample data (takes a few minutes):

    ./ loaddata dashboard_example_data

    Finally, make sure the loaded metrics have at least one data point (this makes API calls to the URLs from the metrics objects loaded above and may take some time depending on the metrics chosen):

    ./ update_metrics
  11. Point the www.djangoproject.localhost, docs.djangoproject.localhost, and dashboard.djangoproject.localhost hostnames with your /etc/hosts file to localhost/  docs.djangoproject.localhost www.djangoproject.localhost dashboard.djangoproject.localhost

    This is unnecessary with some browsers (e.g. Opera and Chromium/Chrome) as they handle localhost subdomains automatically.

    If you're on Mac OS and don't feel like editing the /etc/hosts file manually, there is a great preference pane called Hosts.prefpane. On Ubuntu there is a built-in network admin GUI to do the same. Remember both require admin privileges, just like you'd need when editing /etc/hosts with your favorite editor.

    If you don't have admin rights but have an internet connection, you can use a service like In that case you'll also have to update ALLOWED_HOSTS in djangoproject/settings/ as well as the content of the django_site table in your database.

  12. Compile the CSS (only the source SCSS files are stored in the repository):

    make compile-scss
  13. Finally run the server:

    make run

    This runs both the main site ("www") as well as the docs and dashboard site in the same process. Open http://www.djangoproject.localhost:8000/, http://docs.djangoproject.localhost:8000/, or http://dashboard.djangoproject.localhost:8000/.

Running the tests

We use Travis-CI for continuous testing and GitHub pull request integration. If you're familiar with those systems you should not have any problems writing tests.

Our test results can be found here:

For local development don't hesitate to install tox to run the website's test suite.

Then in the root directory (next to the file) run:


Behind the scenes this will run the usual ./ test management command with a preset list of apps that we want to test as well as flake8 for code quality checks. We collect test coverage data as part of that tox run, to show the result simply run:

coverage report

or for a HTML-based report:

coverage html

(Optional) In case you're using an own virtualenv you can also run the tests manually using the test task of the Makefile. Don't forget to install the test requirements with the following command first though:

pip install -r requirements/tests.txt

Then run:

make test

or simply the usual test management command:

./ test [list of app labels]

Supported browsers

The goal of the site is to target various levels of browsers, depending on their ability to use the technologies in use on the site, such as HTML5, CSS3, SVG, webfonts.

We're following Mozilla's example when it comes to categorize browser support.

  • Desktop browsers, except as noted below, are A grade, meaning that everything needs to work.
  • IE < 11 is not supported (based on Microsoft's support).
  • Mobile browsers should be considered B grade as well. Mobile Safari, Firefox on Android and the Android Browser should support the responsive styles as much as possible but some degredation can't be prevented due to the limited screen size and other platform restrictions.

File locations

Static files such as CSS, JavaScript or image files can be found in the djangoproject/static subdirectory.

Templates can be found in the djangoproject/templates subdirectory.


CSS is written in Scss and compiled via Libsass.

Run the following to compile the Scss files to CSS:

make compile-scss-debug

Alternatively you can also run the following command in a separate shell to continuously watch for changes to the Scss files and automatically compile to CSS:

make watch-scss

Running all at once

Optionally you can use a tool like Foreman to run all process at once:

This is great during development. Assuming you're using Foreman simply run:

foreman start

If you just want to run one of the processes defined above use the run subcommand like so:

foreman run web

That'll just run the www server.

Check out the Procfile file for all the process names.

JavaScript libraries

This project uses Bower to manage JavaScript libraries.

At any time, you can run it to install a new library (e.g., jquery-ui):

npm run bower install jquery-ui --save

or check if there are newer versions of the libraries that we use:

npm run bower ls

If you need to update an existing library, the easiest way is to change the version requirement in bower.json and then to run npm run bower install again.

We commit the libraries to the repository, so if you add, update, or remove a library from bower.json, you will need to commit the changes in djangoproject/static too.

Documentation search

When running ./ update_docs to build all documents it will also automatically index every document it builds in the search engine as well. In case you've already built the documents and would like to reindex the search index run the command:

./ update_index

This is also the right command to run when you work on the search feature itself. You can pass the -d option to try to drop the search index first before indexing all the documents.

Updating metrics from production

The business logic for dashboard metrics is edited via the admin interface and contained in the models in the dashboard app (other than Dataum, which contains the data itself). From time to time, those metrics should be extracted from a copy of the production database and saved to the dashboard/fixtures/dashboard_production_metrics.json file.

To update this file, run:

./ dumpdata dashboard --exclude dashboard.Datum --indent=4 > dashboard_production_metrics.json