diff --git a/keystoneclient/__init__.py b/keystoneclient/__init__.py index ab4f7a1ce..555dfa633 100644 --- a/keystoneclient/__init__.py +++ b/keystoneclient/__init__.py @@ -13,6 +13,15 @@ # License for the specific language governing permissions and limitations # under the License. +"""The python bindings for the OpenStack Identity (Keystone) project. + +See :py:class:`keystoneclient.v3.client.Client` for the Identity V3 client. + +See :py:class:`keystoneclient.v2_0.client.Client` for the Identity V2.0 client. + +""" + + import pbr.version diff --git a/keystoneclient/v3/client.py b/keystoneclient/v3/client.py index 995523019..f632840af 100644 --- a/keystoneclient/v3/client.py +++ b/keystoneclient/v3/client.py @@ -89,6 +89,65 @@ class Client(httpclient.HTTPClient): >>> user = keystone.users.get(USER_ID) >>> user.delete() + Instances of this class have the following managers: + + .. py:attribute:: credentials + + :py:class:`keystoneclient.v3.credentials.CredentialManager` + + .. py:attribute:: endpoint_filter + + :py:class:`keystoneclient.v3.contrib.endpoint_filter.\ +EndpointFilterManager` + + .. py:attribute:: endpoints + + :py:class:`keystoneclient.v3.endpoints.EndpointManager` + + .. py:attribute:: domains + + :py:class:`keystoneclient.v3.domains.DomainManager` + + .. py:attribute:: federation + + :py:class:`keystoneclient.v3.contrib.federation.core.FederationManager` + + .. py:attribute:: groups + + :py:class:`keystoneclient.v3.groups.GroupManager` + + .. py:attribute:: oauth1 + + :py:class:`keystoneclient.v3.contrib.oauth1.core.OAuthManager` + + .. py:attribute:: policies + + :py:class:`keystoneclient.v3.policies.PolicyManager` + + .. py:attribute:: regions + + :py:class:`keystoneclient.v3.regions.RegionManager` + + .. py:attribute:: role_assignments + + :py:class:`keystoneclient.v3.role_assignments.RoleAssignmentManager` + + .. py:attribute:: roles + + :py:class:`keystoneclient.v3.roles.RoleManager` + + .. py:attribute:: services + + :py:class:`keystoneclient.v3.services.ServiceManager` + + .. py:attribute:: users + + :py:class:`keystoneclient.v3.users.UserManager` + + .. py:attribute:: trusts + + :py:class:`keystoneclient.v3.contrib.trusts.TrustManager` + """ version = 'v3'