diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 90 |
1 files changed, 0 insertions, 90 deletions
diff --git a/README.rst b/README.rst deleted file mode 100644 index 2c8dabd4..00000000 --- a/README.rst +++ /dev/null @@ -1,90 +0,0 @@ -Django REST framework -===================== - -**Django REST framework makes it easy to build well-connected, self-describing RESTful Web APIs.** - -**Author:** Tom Christie. `Follow me on Twitter <https://twitter.com/_tomchristie>`_. - -:build status: |build-image| - -.. |build-image| image:: https://secure.travis-ci.org/tomchristie/django-rest-framework.png?branch=master - :target: https://secure.travis-ci.org/tomchristie/django-rest-framework - -**Important!** REST framework 2.0 is due to be released to PyPI by the end of October. -If you are considering building a new API using REST framework you should start working -with the `restframework2` branch, and refering to the upcoming `REST framework 2 docs <http://tomchristie.github.com/django-rest-framework>`_. - -Overview -======== - -Features: - -* Creates awesome self-describing *web browse-able* APIs. -* Clean, modular design, using Django's class based views. -* Easily extended for custom content types, serialization formats and authentication policies. -* Stable, well tested code-base. -* Active developer community. - -Full documentation for the project is available at http://django-rest-framework.org - -Issue tracking is on `GitHub <https://github.com/tomchristie/django-rest-framework/issues>`_. -General questions should be taken to the `discussion group <http://groups.google.com/group/django-rest-framework>`_. - -Requirements: - -* Python 2.6+ -* Django 1.3+ - - -Installation Notes -================== - -To clone the project from GitHub using git:: - - git clone git@github.com:tomchristie/django-rest-framework.git - - -To install django-rest-framework in a virtualenv environment:: - - cd django-rest-framework - virtualenv --no-site-packages --distribute 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 the sdist packages:: - - python setup.py sdist --formats=gztar,zip |