cloudcix 0.2.48

Python bindings and utils for CloudCIX API.

Python bindings and utils to make the work with CloudCIX API fun and easy.

API Docs

CloudCIX is developed by CIX

Requirements

• CloudCIX Account

• CloudCIX Account’s Member ID under Member ID

• Python 2.7.x

• pip or download zip

It is crucial that you install Python 2.7, this library was not designed for use with Python 3+.

Pre Installation with pip

Download get-pip.py and run

python get-pip.py

Installation

With pip:

pip install -U cloudcix

Without pip * download this * extract to your project folder * open a new python file and add the settings described below:

Required settings

When you run your project you should set the settings variable CLOUDCIX_SETTINGS_MODULE to point to the module that contains the settings object.

ENV Based Settings (Basic)

As an alternative when used from console the settings can be set as environment variables.

os.environ['CLOUDCIX_SERVER_URL'] = 'https://api.cloudcix.com/'
# utils method get_admin_token and get_admin_session, will require you to set
# following environment variables as well
os.environ['CLOUDCIX_API_USERNAME'] = 'EMAIL'     # CloudCIX login
os.environ['CLOUDCIX_API_PASSWORD'] = 'PASSWORD'  # CloudCIX password
os.environ['CLOUDCIX_API_ID_MEMBER'] = 'NUMBER'   # CloudCIX Member ID (see Requirements)
os.environ['OPENSTACK_KEYSTONE_URL'] = 'https://keystone.cloudcix.com:5000/v3'

Module Based Settings (Advanced)

# In main python script
import os
os.environ.setdefault("CLOUDCIX_SETTINGS_MODULE", "my_project.my_settings")

# In my_project/my_settings.py
CLOUDCIX_SERVER_URL = 'https://api.cloudcix.com'
CLOUDCIX_API_USERNAME = 'EMAIL'     # CloudCIX login
CLOUDCIX_API_PASSWORD = 'PASSWORD'  # CloudCIX password
CLOUDCIX_API_ID_MEMBER = 'NUMBER'   # CloudCIX Member ID (see Requirements)
OPENSTACK_KEYSTONE_URL = 'https://keystone.cloudcix.com:5000/v3'

Django Settings (Advanced)

# In settings.py
INSTALLED_APPS = (
  ...
  'django_cloudcix'
)

CLOUDCIX_SERVER_URL = 'https://api.cloudcix.com'
CLOUDCIX_API_USERNAME = 'EMAIL'     # CloudCIX login
CLOUDCIX_API_PASSWORD = 'PASSWORD'  # CloudCIX password
CLOUDCIX_API_ID_MEMBER = 'NUMBER'   # CloudCIX Member ID (see Requirements)
OPENSTACK_KEYSTONE_URL = 'https://keystone.cloudcix.com:5000/v3'

Sample usage

Use the language service

import os

os.environ['CLOUDCIX_SERVER_URL'] = 'https://api.cloudcix.com'
os.environ['CLOUDCIX_API_USERNAME'] = 'EMAIL'
os.environ['CLOUDCIX_API_PASSWORD'] = 'PASSWORD'
os.environ['CLOUDCIX_API_ID_MEMBER'] = 'NUMBER'
os.environ['OPENSTACK_KEYSTONE_URL'] = 'https://keystone.cloudcix.com:5000/v3'

# NOTE: environ variables must be set before importing cloudcix

from cloudcix import api
from cloudcix.utils import get_admin_session

token = get_admin_session().get_token()
response = api.membership.language.list(token=token)

print response.json()

More Examples

see examples folder for more.