python-keystoneclient/doc/source/index.rst

Python bindings to the OpenStack Identity API (Keystone)
========================================================

This is a client for OpenStack Identity API. There's a Python API for
:doc:`Identity API v3 <using-api-v3>` and :doc:`v2 <using-api-v2>` (the
:mod:`keystoneclient` modules), and a command-line script (installed as
:doc:`keystone <man/keystone>`).

Contents:

.. toctree::
   :maxdepth: 1

   man/keystone
   using-api-v3
   using-sessions
   authentication-plugins
   using-api-v2
   api/modules

Related Identity Projects
=========================

In addition to creating the Python client library, the Keystone team also
provides `Identity Service`_, as well as `WSGI Middleware`_.

.. _`Identity Service`: http://docs.openstack.org/developer/keystone/
.. _`WSGI Middleware`: http://docs.openstack.org/developer/keystonemiddleware/

Release Notes
=============

.. toctree::
   :maxdepth: 1

   history

Contributing
============

Code is hosted `on GitHub`_. Submit bugs to the Keystone project on
`Launchpad`_. Submit code to the ``openstack/python-keystoneclient`` project
using `Gerrit`_.

.. _on GitHub: https://github.com/openstack/python-keystoneclient
.. _Launchpad: https://launchpad.net/python-keystoneclient
.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow

Run tests with ``tox``.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Replace refs to 'Keystone API' with 'Identity API' Formally, OpenStack Keystone implements the OpenStack Identity API, and this is a client to the API, not to Keystone itself. Change-Id: If568866221a29ba041f0f2cd56dc81deeb9ebc00 2012-10-24 07:12:30 -05:00			`Python bindings to the OpenStack Identity API (Keystone)`
			`========================================================`
Initial commit. 2011-10-25 16:50:08 -07:00
Add link to the v3 client api doc There was no link from the main page to the v3 client API doc so there's no easy way to get to it or to know that it's there. This adds the link. Change-Id: I3fd49eedcf7b79f6d810ed22cfcffba4ce47dece 2014-02-02 10:36:38 -06:00			`This is a client for OpenStack Identity API. There's a Python API for`
			:doc:`Identity API v3 <using-api-v3>` and :doc:`v2 <using-api-v2>` (the
Remove reference to non-existent shell doc There's no "shell.rst" document, so the index shouldn't reference it. Change-Id: I0d02b32349cfb6592b432700b4e04fda7fecbba8 2014-02-02 11:36:39 -06:00			:mod:`keystoneclient` modules), and a command-line script (installed as
			:doc:`keystone <man/keystone>`).
Initial commit. 2011-10-25 16:50:08 -07:00
			`Contents:`

			`.. toctree::`
Updated the docs a little bit. 2011-10-31 15:59:25 -07:00			`:maxdepth: 1`
Initial commit. 2011-10-25 16:50:08 -07:00
Provide keystone CLI man page. Resolves: bug 1185142 Implements blueprint: clients-man-pages Provide basic but hopefully useful man page. shell.rst was merged into and replaced by the man page in HTML docs. Change-Id: I0a90e4638cc7e4ed9c02c5abd7d84a4079e5f50d 2013-05-28 20:37:43 +02:00			`man/keystone`
Add link to the v3 client api doc There was no link from the main page to the v3 client API doc so there's no easy way to get to it or to know that it's there. This adds the link. Change-Id: I3fd49eedcf7b79f6d810ed22cfcffba4ce47dece 2014-02-02 10:36:38 -06:00			`using-api-v3`
Reorder index links The V3 Client link should come before the V2 Client link if that's what we want developers to use. Change-Id: I34a232d21862999a6f1a7acf5382ff752a7e3590 2014-10-10 19:24:50 -05:00			`using-sessions`
Document authentication plugins Explain the plugins that are provided and some information on how to write new ones. This will obviously need to be expanded as more features are added. Change-Id: Ie67e93f2ed994c3702ac66e388cf216609dd44ff 2014-03-31 16:16:44 +10:00			`authentication-plugins`
Reorder index links The V3 Client link should come before the V2 Client link if that's what we want developers to use. Change-Id: I34a232d21862999a6f1a7acf5382ff752a7e3590 2014-10-10 19:24:50 -05:00			`using-api-v2`
Fix doc build errors There were some parts that had invalid RST in their docstrings which caused warnings and errors to be generated. Related-Bug: #1278662 Change-Id: Ibb53e6f49b5fa100fa6ecfe47331f9a70729d03b 2014-02-16 12:03:58 -06:00			`api/modules`
Initial commit. 2011-10-25 16:50:08 -07:00
Crosslink to other sites that are owned by Keystone Add links to identity service and keystone middleware to the landing page. This indicates to the user that the three projects are related. Change-Id: I37bb4cd866524bad69f90c53e6a58d58202fc263 Co-Authored-By: Steve Martinelli <stevemar@ca.ibm.com> Partial-Bug: #1428321 2015-03-11 18:30:11 +08:00			`Related Identity Projects`
			`=========================`

			`In addition to creating the Python client library, the Keystone team also`
			provides `Identity Service`_, as well as `WSGI Middleware`_.

			.. _`Identity Service`: http://docs.openstack.org/developer/keystone/
			.. _`WSGI Middleware`: http://docs.openstack.org/developer/keystonemiddleware/

auto-generate release history currently there is no release history for keystoneclient, though sometimes the commits are lacking context, this automated approach is far better than nothing. Change-Id: Ibb865b4830cbe1e2e99688103d26f1378d2c32b1 2015-09-25 00:18:50 -04:00			`Release Notes`
			`=============`

			`.. toctree::`
			`:maxdepth: 1`

			`history`

Initial commit. 2011-10-25 16:50:08 -07:00			`Contributing`
			`============`

updating keystoneclient doc theme adding in openstack theming enabling last update from git removing old manual references to API, converted entirely to autodoc updated .gitignore fixed docstring warnings and errors Change-Id: Id22ddc446331d52cbf56c3462d8b532fc37f64ac 2012-09-29 15:28:08 -07:00			Code is hosted `on GitHub`_. Submit bugs to the Keystone project on
Replace refs to 'Keystone API' with 'Identity API' Formally, OpenStack Keystone implements the OpenStack Identity API, and this is a client to the API, not to Keystone itself. Change-Id: If568866221a29ba041f0f2cd56dc81deeb9ebc00 2012-10-24 07:12:30 -05:00			`Launchpad`_. Submit code to the ``openstack/python-keystoneclient`` project
			using `Gerrit`_.
Initial commit. 2011-10-25 16:50:08 -07:00
Updated Sphinx documentation - Added examples using the API - Added API reference pages - Added docstrings to classes so they would be picked up by sphinx - Removed warning about CLI coming soon Change-Id: I6e187efe508c5ae310ec97efe4650495f958306d 2012-05-04 09:33:29 -04:00			`.. _on GitHub: https://github.com/openstack/python-keystoneclient`
updating keystoneclient doc theme adding in openstack theming enabling last update from git removing old manual references to API, converted entirely to autodoc updated .gitignore fixed docstring warnings and errors Change-Id: Id22ddc446331d52cbf56c3462d8b532fc37f64ac 2012-09-29 15:28:08 -07:00			`.. _Launchpad: https://launchpad.net/python-keystoneclient`
Workflow documentation is now in infra-manual Replace URLs for workflow documentation to appropriate parts of the OpenStack Project Infrastructure Manual. Change-Id: I5b4f7bc5268132b129fc56c919af00d7f9600c9f 2014-12-05 03:30:39 +00:00			`.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow`
Initial commit. 2011-10-25 16:50:08 -07:00
Correct test running instructions To run the tests just do `tox`. Change-Id: Ibe61e63c1d7b3a1b1dd3186ae5930a67fdba9ed3 2016-02-28 11:03:44 -06:00			Run tests with ``tox``.
Initial commit. 2011-10-25 16:50:08 -07:00
			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`