umapi-client.py

This is a Python client for the User Management API from Adobe, aka the UMAPI.

The User Management API is an Adobe-hosted network service which provides Adobe Enterprise customers the ability to manage their users. This client makes it easy to access the UMAPI from a local Python application.

See the user guide for more information.

Compatibility

The 3.x release branch is actively maintained. New users of the UMAPI client should use the latest 3.x release. The 2.x branch is still supported, but new 2.x releases will only contain bug fixes. New features will only be developed for 3.x.

Pull requests for 3.x should be made against the v3 branch (the default branch). Anything related to 2.x bugfixes should target v2.

Installation

umapi-client.py is published to the Python Packaging Index.

https://pypi.org/project/umapi-client/

It can be installed with pip:

$ pip install umapi-client

Or a dependency manager such as Poetry:

$ poetry add umapi-client

Building

Poetry is required to build the package. Follow the instructions documented on Poetry's website to install it on your system.

Clone this repository

$ git clone https://github.com/adobe-apiplatform/umapi-client.py
$ cd umapi-client.py

Install dependencies to virtual environment.
```
$ poetry install
```
The build command will create a source package (.tar.gz) and a wheel file (.whl) in the dist directory.
```
$ poetry build
$ ls dist
umapi-client-3.0.1.tar.gz  umapi_client-3.0.1-py3-none-any.whl
```
Some of the packages required by this module use encryption, and so may require you to do local builds of modules that use SSL. Typically, this will require you to have a python installed that supports compiling extensions.
Run tests with pytest.
```
$ poetry run pytest
```

Usage

Usage documentation, as well as information about how to get client credentials for use of the UMAPI, can be found in the user guide, whose sources are in the docs directory of this repository.

License

This project is licensed under the MIT License. See LICENSE for more information.

Release files for umapi-client 3.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for umapi-client 3.0.1
File	Size	Uploaded
umapi_client-3.0.1.tar.gz	18.4 kB	Jul 20, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for umapi-client 3.0.1
File	Interpreter	ABI	Platform	Reset
umapi_client-3.0.1-py3-none-any.whl 23.5 kB Jul 20, 2023	Python 3	none	any	Details

Total release size: 42.0 kB

Release files / umapi_client-3.0.1.tar.gz

Download URL	umapi_client-3.0.1.tar.gz
Size	18.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`1570fdcf76a62b12a3ae767e2878591ae124d7743a62973250da90819cf654cf`
BLAKE2b-256 checksum How to use checksums	`4301c951e1d2c44a5fc9ee28460476956f1e22c1cf57dc4789f97ee40f66887f`
Upload date	Jul 20, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.3.1 CPython/3.11.4 Linux/5.15.0-1041-azure`

Release files / umapi_client-3.0.1-py3-none-any.whl

Download URL	umapi_client-3.0.1-py3-none-any.whl
Size	23.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`3ced9c9a4bafea2407a92f3ca70f75ee8bb7dcaaef676d17f9d7aad171d96f1f`
BLAKE2b-256 checksum How to use checksums	`a34eccf0a0281501fa59e41ee600796a4708989875320a71d1dc228236ab386e`
Upload date	Jul 20, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.3.1 CPython/3.11.4 Linux/5.15.0-1041-azure`