diff options
author | Jenkins <jenkins@review.openstack.org> | 2014-11-13 14:48:54 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2014-11-13 14:48:54 +0000 |
commit | 5502ab9f1e437e73046b31476c542be90b5b0aae (patch) | |
tree | 845cfe6c4c8758940c8c3c18d458033748c949f6 | |
parent | f9d22f16c2d9e21998829565d2a32732acebbe1f (diff) | |
parent | 613da0b10e2397d0534dd2b55e40bc3dab18a6dd (diff) | |
download | django_openstack_auth-5502ab9f1e437e73046b31476c542be90b5b0aae.tar.gz |
Merge "Updated the installation instructions"
-rw-r--r-- | README.rst | 31 | ||||
-rw-r--r-- | doc/source/installation.rst | 45 |
2 files changed, 41 insertions, 35 deletions
@@ -6,37 +6,12 @@ Django OpenStack Auth is a pluggable Django authentication backend that works with Django's ``contrib.auth`` framework to authenticate a user against OpenStack's Keystone Identity API. -The current version is designed to work with the Keystone V2 API. +The current version is designed to work with the Keystone v2.0 and v3 API. You can `view the documentation`_ on Read The Docs. .. _view the documentation: http://django-openstack-auth.readthedocs.org/en/latest/ -Installation -============ +You can `view the installation instructions`_ on Read The Docs. -Installing is quick and easy: - -#. Run ``pip install django_openstack_auth``. - -#. Add ``openstack_auth`` to ``settings.INSTALLED_APPS``. - -#. Add ``'openstack_auth.backend.KeystoneBackend'`` to your - ``settings.AUTHENTICATION_BACKENDS``, e.g.:: - - AUTHENTICATION_BACKENDS = ('openstack_auth.backend.KeystoneBackend',) - -#. Configure your API endpoint(s) in ``settings.py``:: - - OPENSTACK_KEYSTONE_URL = "http://example.com:5000/v2.0" - -#. Include ``'keystone_auth.urls'`` somewhere in your ``urls.py`` file. - -#. Use it as you would any other Django auth backend. - -Running The Tests -================= - -Download the repository and run:: - - python setup.py test +.. _view the installation instructions: http://django-openstack-auth.readthedocs.org/en/latest/installation.html#installation diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 6ac0379..866152f 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -11,22 +11,53 @@ Installing is quick and easy: #. Add ``openstack_auth`` to ``settings.INSTALLED_APPS``. -#. Add ``'keystone_auth.backend.KeystoneBackend'`` to your +#. Add ``'openstack_auth.backend.KeystoneBackend'`` to your ``settings.AUTHENTICATION_BACKENDS``, e.g.:: - AUTHENTICATION_BACKENDS = ('keystone_auth.backend.KeystoneBackend',) + AUTHENTICATION_BACKENDS = ('openstack_auth.backend.KeystoneBackend',) #. Configure your API endpoint(s) in ``settings.py``:: OPENSTACK_KEYSTONE_URL = "http://example.com:5000/v3" -#. Include ``'keystone_auth.urls'`` somewhere in your ``urls.py`` file. +#. Include ``'openstack_auth.urls'`` somewhere in your ``urls.py`` file. #. Use it as you would any other Django auth backend. -Running The Tests -================= +Running Tests +============= -Download the repository and run:: +Before running tests, you should have ``tox`` installed and available in your +environment: - python setup.py test +.. code-block:: bash + + $ pip install tox + +.. NOTE:: + + You may need to perform both the above operation and the next inside a + python virtualenv, or prefix the above command with ``sudo``, depending on + your preference. + +To execute the full suite of tests maintained within the project, simply run: + +.. code-block:: bash + + $ tox + +.. NOTE:: + + The first time you run ``tox``, it will take additional time to build + virtualenvs. You can later use the ``-r`` option with ``tox`` to rebuild + your virtualenv in a similar manner. + +To run tests for one or more specific test environments (for example, the most +common configuration of Python 2.7 and PEP-8), list the environments with the +``-e`` option, separated by spaces: + +.. code-block:: bash + + $ tox -e py27,pep8 + +See ``tox.ini`` for the full list of available test environments. |