sgzijl/cloud-conformity-python-library

Python library to interact with Cloud Conformity API

cloud-conformity-python-library

Python library to interact with Cloud Conformity API

Supported Functionality

Not all APIs are covered by this library yet. You can find the list of supported APIs below:

• External IDs API
  • Get Organisation External ID
• Accounts API
  • Create Account
  • List Accounts
  • Update Account
  • Delete Account
  • Update Account Bot Setting
• Settings API
  • List Communication Settings
  • Delete Communication Settings
• Profiles API
  • List Profiles
  • Get Profile
  • Apply Profile to Accounts
• Report Configs API
  • Create Report Config

Requirements

You should have the following tools to install this library:

• Python 3.X.X
• Virtualenv (Optional but recommended)

Installation

You can use pip and virtualenv. Create a new virtual environment, then activate the environment and install:

$ virtualenv -p python3 <path_to_anywhere_you_want_to>
$ source <path_to_anywhere_you_want_to>/bin/activate
$ pip install cloud-conformity

The other way, you can install it to your system's Python 3 (without virtualenv). In that case, sudo is most likely be required and pip3 is the command you should be using to install the package to your Python 3:

$ sudo pip3 install cloud-conformity

Test Your Installation

If you are using virtualenv, make sure the environment is activated. If not, make sure you are using the correct python:

$ python3

In the python interpreter, insert the following statements:

>>> from cloud_conformity import CloudConformity
>>> CloudConformity

The output should be: <class 'cloud_conformity.cloud_conformity.CloudConformity'>

Maintainer Guide

1. After updating the code, make sure to update the code version on setup.py
2. Follow this guide to ship the code to PyPi:

Author

• Rafi Kurnia Putra

License

Apache 2 Licensed. See LICENSE for full details.