django-rest-framework/README

# To install django-rest-framework in a virtualenv environment...

hg clone https://tomchristie@bitbucket.org/tomchristie/django-rest-framework
cd django-rest-framework/
virtualenv --no-site-packages --distribute --python=python2.6 env
source ./env/bin/activate
pip install -r requirements.txt # django, coverage

# To run the tests...

export PYTHONPATH=.    # Ensure djangorestframework is on the PYTHONPATH
python djangorestframework/runtests/runtests.py


# To run the test coverage report...

export PYTHONPATH=.    # Ensure djangorestframework is on the PYTHONPATH
python djangorestframework/runtests/runcoverage.py

# To run the examples...

pip install -r examples/requirements.txt # pygments, httplib2, markdown
cd examples
export PYTHONPATH=..
python manage.py syncdb
python manage.py runserver

# To build the documentation...

pip install -r docs/requirements.txt   # sphinx
sphinx-build -c docs -b html -d docs/build docs html

# To run the tests against the full set of supported configurations

deactivate  # Ensure we are not currently running in a virtualenv
tox

# To create sdist packages

python setup.py sdist --formats=gztar,zip