5740a0d6aa
* adds "what's where" section which isn't wildly interesting right now but it's somewhat interesting * adds "wiping environment" section
154 lines
3.3 KiB
ReStructuredText
154 lines
3.3 KiB
ReStructuredText
.. _hacking-howto:
|
|
|
|
===============
|
|
Hacking HOWTO
|
|
===============
|
|
|
|
|
|
So you want to hack on GNU MediaGoblin?
|
|
=======================================
|
|
|
|
First thing to do is check out the Web site where we list all the
|
|
project infrastructure including:
|
|
|
|
* the mailing list
|
|
* the IRC channel
|
|
* the bug tracker
|
|
|
|
Additionally, we have information on how to get involved, who to talk
|
|
to, what needs to be worked on, and other things besides!
|
|
|
|
|
|
How to set up and maintain an environment for hacking
|
|
=====================================================
|
|
|
|
|
|
Getting requirements
|
|
--------------------
|
|
|
|
First, you need to have the following installed before you can build
|
|
an environment for hacking on GNU MediaGoblin:
|
|
|
|
* Python 2.6 or 2.7 - http://www.python.org/
|
|
|
|
You'll need Python as well as the dev files for building modules.
|
|
|
|
* python-lxml - http://lxml.de/
|
|
* git - http://git-scm.com/
|
|
* MongoDB - http://www.mongodb.org/
|
|
|
|
If you're running Debian GNU/Linux or a Debian-derived distribution
|
|
such as Mint or Ubuntu, running the following should install these
|
|
requirements::
|
|
|
|
sudo apt-get install mongodb git-core python python-dev \
|
|
python-lxml
|
|
|
|
|
|
Running bootstrap and buildout
|
|
------------------------------
|
|
|
|
After installing the requirements, follow these steps:
|
|
|
|
1. Clone the repository::
|
|
|
|
git clone http://git.gitorious.org/mediagoblin/mediagoblin.git
|
|
|
|
2. Bootstrap and run buildout::
|
|
|
|
cd mediagoblin
|
|
python bootstrap.py && ./bin/buildout
|
|
|
|
|
|
That's it! Using this method, buildout should create a ``user_dev``
|
|
directory, in which certain things will be stored (media, beaker
|
|
session stuff, etc). You can change this, but for development
|
|
purposes this default should be fine.
|
|
|
|
|
|
.. Note::
|
|
|
|
We used `zc.buildout <http://www.buildout.org/>`_ because it
|
|
involves fewer steps to get things running and less knowledge of
|
|
Python packaging. However, if you prefer to use `virtualenv
|
|
<http://pypi.python.org/pypi/virtualenv>`_, that should work just
|
|
fine.
|
|
|
|
|
|
Updating dependencies
|
|
---------------------
|
|
|
|
While hacking on GNU MediaGoblin over time, you'll eventually have to
|
|
update your development environment. To do that, run::
|
|
|
|
./bin/buildout
|
|
|
|
|
|
Wiping your environment for a clean-slate
|
|
-----------------------------------------
|
|
|
|
Delete the following directories:
|
|
|
|
* bin/
|
|
* develop-eggs/
|
|
* eggs/
|
|
* mediagoblin.egg-info/
|
|
* parts/
|
|
* user_dev/
|
|
|
|
FIXME - how to drop data from mongodb?
|
|
|
|
|
|
Running the server
|
|
==================
|
|
|
|
Run::
|
|
|
|
./bin/paster serve mediagoblin.ini --reload
|
|
|
|
|
|
Running the test suite
|
|
======================
|
|
|
|
Run::
|
|
|
|
./bin/nosetests
|
|
|
|
|
|
What's where
|
|
============
|
|
|
|
After you've run buildout, you're faced with the following directory
|
|
tree::
|
|
|
|
mediagoblin/
|
|
|- mediagoblin/ source code
|
|
| |- tests/
|
|
| |- templates/
|
|
| |- auth/
|
|
| \- submit/
|
|
|- docs/ documentation
|
|
|
|
|
| the rest of these directories are generated by
|
|
| buildout.
|
|
|
|
|
|- bin/ scripts
|
|
|- develop-eggs/
|
|
|- eggs/
|
|
|- mediagoblin.egg-info/
|
|
|- parts/
|
|
|- user_dev/ sessions, etc
|
|
|
|
|
|
|
|
Quickstart for Django programmers
|
|
=================================
|
|
|
|
FIXME - write this
|
|
|
|
|
|
Bite-sized bugs to start with
|
|
=============================
|
|
|
|
FIXME - write this
|