Skip to content

Latest commit

 

History

History
109 lines (79 loc) · 3.2 KB

README.rst

File metadata and controls

109 lines (79 loc) · 3.2 KB
Raw

AMaaS Core SDK for Python

This is the Asset Management as a Service (AMaaS) Software Development Kit (SDK) for Python.

What is AMaaS?

AMaaS is a modular platform for Asset Managers with an open, RESTful API for programmatic access to its functionality.

AMaaS Core features a secure, encrypted database, which serves as the foundation for asset management platforms and FinTech solutions. AMaaS also provides portfolio visualizations and analytics through AMaaS Web, and exception management & financial event notification through AMaaS Monitor.

Quick Start

Install the AMaaS Core library from PyPI:

$ pip install amaascore

This module can then be immediately embedded into your Python applications to take advantage of the standardised class structure.

Configuring Credentials

When calling the AMaaS APIs, the AMaaS Core library will search for your credentials from different locations. The order in which credentials are searched are as follows:

  1. Credentials passed in the AMaaS API Interface constructors
  2. Environment variables
  3. AMaaS configuration file (~/.amaas.cfg) [Recommended]

Constructor Parameter

assets_interface = AssetsInterface(username='myusername', password='mypassword')

Environment Variables

The AMaaS Core library will check these environment variables for your credentials

  • AMAAS_USERNAME
  • AMAAS_PASSWORD

AMaaS configuration file

This is the recommended way of configuring your credentials. Create a file called .amaas.cfg in your homedir, with the following:

[auth]
username=YOUR_USERNAME
password=YOUR_PASSWORD

Note that the password is never transferred across the wire as AMaaS uses the Secure Remote Password protocol: https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol

For deployments not in the known set, you must also specify the following information regarding the stage:

[stages.<stage>]
cognito_region=<rg-location-1>
cognito_pool_id=<rg-location-1_Ab1Cd2Ef3>
cognito_client_id=<1ab2cd3ef4gh5ij6kl7mn8op9>

Example code and demonstrations

For examples of how the Python SDK can be used, clone the "AMaaS Core SDK for Python Examples" repository from: https://github.com/amaas-fintech/amaas-core-sdk-python-examples.

A variety of demos are available such as:

  • Book a set of transactions and then view the cumulative position
  • Back-dated transaction handling
  • Signup clients and then book ETFs on their behalf, while managing their cash
  • A simulation of a simplified robo-advisor

Testing

The SDK contains wide-ranging unit tests within the AMaaS Core package itself. The easiest way to run the whole suite is to install tox, then run it from the root directory (where the tox.ini file resides).

$ pip install tox
$ tox

Individual test modules can be run using unittest in the usual fashion.

Support

For support with the SDKs, please raise issues on GitHub. The AMaaS team can be contacted at [email protected].