Metadata-Version: 2.1
Name: python-adjutantclient
Version: 1.4.0
Summary: Adjutant API Client Library
Home-page: https://github.com/openstack/python-adjutantclient
Author: Adrian Turjak
Author-email: adriant@catalyst.net.nz
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
License-File: LICENSE
Requires-Dist: pbr>=3.0.0
Requires-Dist: cliff>=2.6.0
Requires-Dist: iso8601>=0.1.11
Requires-Dist: osc-lib>=1.8.0
Requires-Dist: PrettyTable>=0.7.1
Requires-Dist: python-openstackclient>=3.11.0
Requires-Dist: oslo.i18n>=2.1.0
Requires-Dist: oslo.serialization>=1.10.0
Requires-Dist: oslo.utils>=3.20.0
Requires-Dist: keystoneauth1>=2.20.0
Requires-Dist: PyYAML>=3.10.0
Requires-Dist: requests>=2.14.2

AdjutantClient is a command-line and python client for Adjutant.

Getting Started
===============

Adjutant Client can be installed from PyPI using pip:

::

    pip install python-openstackclient python-adjutantclient


The command line client is installed as a plugin for the OpenStack client.

Python API
==========

You can use the API with a keystone session:

  >>> from keystoneauth1 import session
  >>> from keystoneauth1.identity import v3
  >>> from adjutantclient.client import Client
  >>> auth = v3.Password(auth_url='http://keystone.host/v3',
                         username='user',
                         password='password',
                         project_name='demo',
                         user_domain_name='default',
                         project_domain_name='default')

  >>> sess = session.Session(auth=auth)
  >>> adjutant = Client('1', session=sess)

If you use a clouds.yaml file os_client_config can also be used:

  >>> import os_client_config
  >>> sess = os_client_config.make_rest_client('admin-logic')
  >>> adjutant = Client('1', session=sess)

A few of the endpoints (users.password_forgot(), token.submit(), signup, token.get()) don't require authentication.
In this case you can instead just pass an endpoint override to the adjutant client constructor.

  >>> from adjutantclient.client import Client
  >>> adjutant = Client('1', endpoint='http://adjutant.host/v1')

