Skip to main content

cloudcix is a Python client for the CloudCIX REST API for rapidly building secure, scalable CloudCIX applications.

For more information about CloudCIX, see here.

Installation

Prerequisites

  1. Create an account on the CloudCIX Platform

  2. Retrieve your API Key

    • Under the My Membership tab in the sidebar, click on Member Details

    • The API Key should be available at the top of the form

  3. Ensure that you have both Python and pip installed

    • As of right now, the cloudcix module is available at different versions for Python2 and Python3

    • We recommend you use Python3 and the latest version of the cloudcix module

    • Python

    • pip

Installing the cloudcix library

The cloudcix library is installed using the pip module.

Depending on your version of Python, you need to install different versions of cloudcix

  • Python3
    • pip3 install -U cloudcix

  • Python2
    • pip install -U 'cloudcix<0.3'

The 0.2 releases are the last to support Python2. If you still use Python2 we recommend you upgrade to Python3 as support will be dropped for these versions in time.

Required settings

In order to run a project, the module requires some settings to exist.

The variables required are as follows:

  • CLOUDCIX_API_URL = https://legacyapi.api.cloudcix.com/ - The base url of the Python2 API

  • CLOUDCIX_API_V2_URL = https://api.cloudcix.com/ - The API name is prepended to this url after the https:// for the Python3 API.

  • CLOUDCIX_API_VERSION = 2 - The version of the api

  • CLOUDCIX_API_USERNAME - The email of the account that you signed up with

  • CLOUDCIX_API_PASSWORD - The password associated with your CloudCIX account

  • CLOUDCIX_API_KEY - The API key associated with your CloudCIX Member (see Prerequisites)

These variables can be declared in a settings file, as follows

# In main python script
import os
os.environ.setdefault('CLOUDCIX_SETTINGS_MODULE', 'my_project.my_settings')
# In my_project/my_settings.py
CLOUDCIX_API_URL = 'https://legacyapi.api.cloudcix.com/'
CLOUDCIX_API_V2_URL = 'https://api.cloudcix.com/'
CLOUDCIX_API_USERNAME = 'EMAIL'               # CloudCIX login
CLOUDCIX_API_PASSWORD = 'PASSWORD'            # CloudCIX password
CLOUDCIX_API_KEY = 'NUMBER/CHARACTER STRING'  # CloudCIX api key
CLOUDCIX_API_VERSION = 2                      # CloudCIX version

Examples

See here for examples on how to use this library.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudcix-5.0.10.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cloudcix-5.0.10-py2.py3-none-any.whl (35.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file cloudcix-5.0.10.tar.gz.

File metadata

  • Download URL: cloudcix-5.0.10.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for cloudcix-5.0.10.tar.gz
Algorithm Hash digest
SHA256 8106aa3a615c443b4c5f75d8aed034a03282283ab1b982dc8184c075ae01a2a9
MD5 069b9cc4896c601c05d463ab481ef7ef
BLAKE2b-256 e43a81a970b84795005df9f19cc75524a2cec3809f7b7555b93ac1aee15a6fc0

See more details on using hashes here.

File details

Details for the file cloudcix-5.0.10-py2.py3-none-any.whl.

File metadata

  • Download URL: cloudcix-5.0.10-py2.py3-none-any.whl
  • Upload date:
  • Size: 35.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for cloudcix-5.0.10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 63aac370acee5ea5424cfd9eff6a4c8cf944f54a2a72cccce79f11da8bcfdd12
MD5 6cf7e6440d0a2ff8e56ad4945a872abe
BLAKE2b-256 b06e56f63924490968e51b930b824e1a1a808234a93a3a58fff66dee981847bf

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page