OpenStack Identity (Keystone) Client
Find a file
Ghanshyam Mann 36510a81b0 Drop lower-constraints.txt and its testing
As discussed in TC PTG[1] and TC resolution[2], we are
dropping the lower-constraints.txt file and its testing.
We will keep lower bounds in the requirements.txt file but
with a note that these are not tested lower bounds and we
try our best to keep them updated.

[1] https://etherpad.opendev.org/p/tc-zed-ptg#L326
[2] https://governance.openstack.org/tc/resolutions/20220414-drop-lower-constraints.html#proposal

Change-Id: I2eea42d3909896ea8606dc9cde681b2cc1cfb62f
2022-04-30 20:20:31 -05:00
doc Merge "remove unicode from code" 2022-04-22 17:21:06 +00:00
examples/pki Update hacking for Python3 2020-03-31 12:16:31 +02:00
keystoneclient Merge "use importlib.metadata to get keyring version" 2022-04-29 17:21:37 +00:00
playbooks Fix keystoneclient-devstack-functional job 2018-11-28 14:45:14 +00:00
releasenotes Merge "Stop using an admin endpoint by default" 2022-04-23 11:17:32 +00:00
.coveragerc Updated coverage configuration file 2016-10-19 12:38:55 +00:00
.gitignore Switch to stestr 2018-07-11 09:59:08 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:39:43 +00:00
.mailmap Add mailmap entry 2014-05-07 12:12:43 -07:00
.stestr.conf Switch to stestr 2018-07-11 09:59:08 +07:00
.zuul.yaml Drop lower-constrait job 2021-04-05 16:16:13 +09:00
bindep.txt Fix bindep.txt to work with newer CentOS and RHEL 2022-02-21 15:34:45 +01:00
CONTRIBUTING.rst Use https for *.openstack.org references 2017-02-05 20:46:32 -08:00
HACKING.rst Update URLs in documents according to document migration 2017-07-14 09:56:01 +08:00
LICENSE Initial commit. 2011-10-25 16:50:08 -07:00
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-04-24 19:16:55 +08:00
requirements.txt Drop lower-constraints.txt and its testing 2022-04-30 20:20:31 -05:00
setup.cfg Remove translation sections from setup.cfg 2022-04-22 15:46:38 +00:00
setup.py Cleanup py27 support 2020-04-04 14:15:46 +02:00
test-requirements.txt [goal] Migrate testing to ubuntu focal 2020-08-16 21:12:07 +00:00
tox.ini Drop lower-constraints.txt and its testing 2022-04-30 20:20:31 -05:00

========================
Team and repository tags
========================

.. image:: https://governance.openstack.org/tc/badges/python-keystoneclient.svg
    :target: https://governance.openstack.org/tc/reference/tags/index.html

.. Change things from this point on

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

.. image:: https://img.shields.io/pypi/v/python-keystoneclient.svg
    :target: https://pypi.org/project/python-keystoneclient/
    :alt: Latest Version

This is a client for the OpenStack Identity API, implemented by the Keystone
team; it contains a Python API (the ``keystoneclient`` module) for
OpenStack's Identity Service. For command line interface support, use
`OpenStackClient`_.

* `PyPi`_ - package installation
* `Online Documentation`_
* `Launchpad project`_ - release management
* `Blueprints`_ - feature specifications
* `Bugs`_ - issue tracking
* `Source`_
* `Specs`_
* `How to Contribute`_
* `Release Notes`_

.. _PyPi: https://pypi.org/project/python-keystoneclient
.. _Online Documentation: https://docs.openstack.org/python-keystoneclient/latest/
.. _Launchpad project: https://launchpad.net/python-keystoneclient
.. _Blueprints: https://blueprints.launchpad.net/python-keystoneclient
.. _Bugs: https://bugs.launchpad.net/python-keystoneclient
.. _Source: https://opendev.org/openstack/python-keystoneclient
.. _OpenStackClient: https://pypi.org/project/python-openstackclient
.. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html
.. _Specs: https://specs.openstack.org/openstack/keystone-specs/
.. _Release Notes: https://docs.openstack.org/releasenotes/python-keystoneclient

.. contents:: Contents:
   :local:

Python API
----------

By way of a quick-start::

    >>> from keystoneauth1.identity import v3
    >>> from keystoneauth1 import session
    >>> from keystoneclient.v3 import client
    >>> auth = v3.Password(auth_url="http://example.com:5000/v3", username="admin",
    ...                     password="password", project_name="admin",
    ...                     user_domain_id="default", project_domain_id="default")
    >>> sess = session.Session(auth=auth)
    >>> keystone = client.Client(session=sess)
    >>> keystone.projects.list()
        [...]
    >>> project = keystone.projects.create(name="test", description="My new Project!", domain="default", enabled=True)
    >>> project.delete()