Metadata-Version: 2.1
Name: serenity.sdk.python
Version: 0.8.8
Summary: Python SDK for the Serenity digital asset risk API
License: MIT
Author: Cloudwall Support
Author-email: support@cloudwall.tech
Requires-Python: >=3.7,<4
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: azure-identity (>=1.10.0,<2.0.0)
Requires-Dist: fire (>=0.4.0,<0.5.0)
Description-Content-Type: text/markdown

## Serenity SDK - Python

### Introduction

The Serenity digital asset risk platform exposes all functionality via an API -- currently REST only.

Although it's possible to call the API with simple HTTP client code in most any modern language, there
are conventions that need to be followed -- especially for authentication and authorization -- and to
make it easier we have provided this lightweight SDK.

### Installation

Installation for Python 3.x users is very simple using pip:

```plain
pip install serenity.sdk.python
```

### Building locally

If you wish to run the local setup you can use the provided ```Makefile```, however this
is primarily aimed for internal Cloudwall use; we recommend clients use pip install.

```bash
# set up a virtual environment with dependencies
make venv

# check code
make link

# run tests
make test

# publish latest code to PyPi (token required)
make publish

# clean up
make clean
```

### Learning more

At this time the API and its documentation are only available to members of our private beta, via
their personal Serenity Developer Portal, e.g. https://developer.$client.cloudwall.network.
