openstack
/
django_openstack_auth
Code Issues Proposed changes

Updated the installation instructions 

Changed the name of the app from keystone_auth to
openstack_auth in the installation instructions

Removed the redudant installation instructions in README.rst

Change-Id: If97c93a446754573bd6fb55b15cb4c881ad1f4e6
This commit is contained in:
James Muranga 2014-09-21 18:47:09 +03:00
parent b2c06648f4
commit 613da0b10e
2 changed files with 41 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.rst
View File

@ -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 works with Django's ``contrib.auth`` framework to authenticate a user against
OpenStack's Keystone Identity API. 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. You can `view the documentation`_ on Read The Docs.
.. _view the documentation: http://django-openstack-auth.readthedocs.org/en/latest/ .. _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: .. _view the installation instructions: http://django-openstack-auth.readthedocs.org/en/latest/installation.html#installation
#. 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

45
doc/source/installation.rst
View File

@ -11,22 +11,53 @@ Installing is quick and easy:
#. Add ``openstack_auth`` to ``settings.INSTALLED_APPS``. #. 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.:: ``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``:: #. Configure your API endpoint(s) in ``settings.py``::
OPENSTACK_KEYSTONE_URL = "http://example.com:5000/v3" 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. #. 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.