We’re going to use all the hottest tools to set up a nice environment. Skip steps at your own peril. Here we go!
OS X and Ubuntu instructions follow.
There are a lot of advanced dependencies we’re going to skip for a fast start. They have their own section.
If you’re on a Linux distro that splits all its packages into -dev and normal stuff, make sure you’re getting all those -dev packages.
The following command will install the required development files on Ubuntu or, if you’re running a recent version, you can install them automatically:
sudo aptitude install python-dev python-virtualenv libxml2-dev libxslt1-dev libmysqlclient-dev libmemcached-dev
Grab zamboni from github with:
git clone --recursive git://github.com/jbalogh/zamboni.git
cd zamboni
git clone --recursive git://github.com/jbalogh/zamboni-lib.git vendor
svn co http://svn.mozilla.org/addons/trunk/site/app/locale locale
zamboni.git is all the source code. zamboni-lib.git is all of our pure-Python dependencies. Updating is detailed later on.
locale contains all of the localizations of the site. Unless you are specifically working with locales, you probably don’t need to touch this again after you check it out.
virtualenv is a tool to create isolated Python environments. We don’t want to install packages system-wide because that can create quite a mess.
sudo easy_install virtualenv
virtualenv is the only Python package I install system-wide. Everything else goes in a virtual environment.
virtualenvwrapper is a set of shell functions that make virtualenv easy to work with.
Install it like this:
wget http://bitbucket.org/dhellmann/virtualenvwrapper/raw/f31869779141/virtualenvwrapper_bashrc -O ~/.virtualenvwrapper
mkdir ~/.virtualenvs
Then put these lines in your ~/.bashrc:
export WORKON_HOME=$HOME/.virtualenvs
source $HOME/.virtualenvwrapper
exec bash and you’re set.
Note
If you didn’t have a .bashrc already, you should make a ~/.profile too:
echo 'source $HOME/.bashrc' >> ~/.profile
virtualenvwrapper lets you run hooks when creating, activating, and deleting virtual environments. These hooks can change settings, the shell environment, or anything else you want to do from a shell script. For complete hook documentation, see http://www.doughellmann.com/docs/virtualenvwrapper/hooks.html.
You can find some lovely hooks to get started at http://gist.github.com/536998. The hook files should go in $WORKON_HOME ($HOME/.virtualenvs from above), and premkvirtualenv should be made executable.
Now we’re ready to go, so create an environment for zamboni:
mkvirtualenv --no-site-packages zamboni
That creates a clean environment named zamboni. You can get out of the environment by restarting your shell or calling deactivate.
To get back into the zamboni environment later, type:
workon zamboni # requires virtualenvwrapper
Note
If you want to use a different Python binary, pass the path to mkvirtualenv with --python:
mkvirtualenv --python=/usr/local/bin/python2.6 --no-site-packages zamboni
From inside your activated virtualenv, run:
pip install -r requirements/compiled.txt
pip installs a few packages into our new virtualenv that we can’t distribute in zamboni-lib. These require a C compiler.
Most of zamboni is already configured in settings.py, but there’s some things you need to configure locally. All your local settings go into settings_local.py. Make sure you have
from settings import *
at the top of your settings_local.py. The settings template for developers, included below, is at docs/settings/settings_local.dev.py.
from settings import *
DEBUG = True
TEMPLATE_DEBUG = DEBUG
DEBUG_PROPAGATE_EXCEPTIONS = DEBUG
# These apps are great during development.
INSTALLED_APPS += (
'debug_toolbar',
'django_extensions',
'fixture_magic',
'django_qunit',
)
# You want one of the caching backends. Dummy won't do any caching, locmem is
# cleared every time you restart the server, and memcached is what we run in
# production.
# CACHE_BACKEND = 'caching.backends.memcached://localhost:11211?timeout=500'
CACHE_BACKEND = 'caching.backends.locmem://'
# Some cache is required for CSRF to work. Dummy will allow some functionality,
# but won't allow you to login.
# CACHE_BACKEND = 'dummy://'
DATABASES = {
'default': {
'NAME': 'zamboni',
'ENGINE': 'django.db.backends.mysql',
'USER': 'jbalogh',
'PASSWORD': 'xxx',
'OPTIONS': {'init_command': 'SET storage_engine=InnoDB'},
'TEST_CHARSET': 'utf8',
'TEST_COLLATION': 'utf8_general_ci',
},
}
# Skip indexing ES to speed things up?
SKIP_SEARCH_INDEX = False
LOG_LEVEL = logging.DEBUG
HAS_SYSLOG = False
# For debug toolbar.
if DEBUG:
INTERNAL_IPS = ('127.0.0.1',)
MIDDLEWARE_CLASSES += ('debug_toolbar.middleware.DebugToolbarMiddleware',)
DEBUG_TOOLBAR_CONFIG = {
'HIDE_DJANGO_SQL': False,
'INTERCEPT_REDIRECTS': False,
}
# If you're not running on SSL you'll want this to be False.
SESSION_COOKIE_SECURE = False
SESSION_COOKIE_DOMAIN = None
# Run tasks immediately, don't try using the queue.
CELERY_ALWAYS_EAGER = True
# Disables custom routing in settings.py so that tasks actually run.
CELERY_ROUTES = {}
# paths for images, not necessary for dev
STATIC_URL = ''
# The user id to use when logging in tasks. You should set this to a user that
# exists in your site.
# TASK_USER_ID = 1
I’m overriding the database parameters from settings.py and then extending INSTALLED_APPS and MIDDLEWARE_CLASSES to include the Django Debug Toolbar. It’s awesome, you want it.
You can get a testing database from https://landfill.addons.allizom.org/db/.
If you’ve gotten the system requirements, downloaded zamboni and zamboni-lib, set up your virtualenv with the compiled packages, and configured your settings and database, you’re good to go. Run the server:
./manage.py runserver 0.0.0.0:8000
Come talk to us on irc://irc.mozilla.org/amo if you have questions, issues, or compliments.
The Testing page has more info, but here’s the quick way to run zamboni’s tests:
./manage.py test
This updates zamboni:
git checkout master && git pull && git submodule update --init
This updates zamboni-lib in the vendor/ directory:
pushd vendor && git pull && git submodule update --init && popd
We use schematic to run migrations:
./vendor/src/schematic/schematic migrations
The Contributing page has more on managing branches.
If you want to pull in the latest locales:
pushd locale && svn up && popd
See the Contributing page.
In production we use things like memcached, rabbitmq + celery, sphinx, redis, and LESS. Learn more about installing these on the Getting Fancy page.