diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/client-api.rst | 22 | ||||
| -rw-r--r-- | doc/source/conf.py | 2 | ||||
| -rw-r--r-- | doc/source/swiftclient.rst | 6 |
3 files changed, 29 insertions, 1 deletions
diff --git a/doc/source/client-api.rst b/doc/source/client-api.rst index b0bb637..57f49cb 100644 --- a/doc/source/client-api.rst +++ b/doc/source/client-api.rst @@ -18,6 +18,28 @@ version are detailed below, but are just a subset of those that can be used to successfully authenticate. These are the most common and recommended combinations. +Keystone Session +~~~~~~~~~~~~~~~~ + +.. code-block:: python + + from keystoneauth1 import session + from keystoneauth1.identity import v3 + + # Create a password auth plugin + auth = v3.Password(auth_url='http://127.0.0.1:5000/v3/', + username='tester', + password='testing', + user_domain_name='Default', + project_name='Default', + project_domain_name='Default') + + # Create session + session = session.Session(auth=auth) + + # Create swiftclient Connection + swift_conn = Connection(session=session) + Keystone v3 ~~~~~~~~~~~ diff --git a/doc/source/conf.py b/doc/source/conf.py index 5af77b2..3505f13 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -51,7 +51,7 @@ master_doc = 'index' # General information about the project. project = u'Swiftclient' -copyright = u'2013 OpenStack, LLC.' +copyright = u'2013-2016 OpenStack, LLC.' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/doc/source/swiftclient.rst b/doc/source/swiftclient.rst index e96afba..108443a 100644 --- a/doc/source/swiftclient.rst +++ b/doc/source/swiftclient.rst @@ -5,6 +5,12 @@ swiftclient .. automodule:: swiftclient +swiftclient.authv1 +================== + +.. automodule:: swiftclient.authv1 + :inherited-members: + swiftclient.client ================== |