Overview
========
``cloudcix`` is a Python client for the CloudCIX REST API for rapidly building secure, scalable CloudCIX applications.
For more information about CloudCIX, see `here <http://www.cix.ie/#/services/saas>`__.
Installation
------------
Prerequisites
~~~~~~~~~~~~~
1. Create an account on the CloudCIX Platform
- `Register <https://saas.cloudcix.com/auth/register>`__
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 <http://docs.python-guide.org/en/latest/starting/installation/>`__
- `pip <https://pip.pypa.io/en/stable/installing/>`__
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``
- The base url of the Python2 API
- Usually ``https://api.cloudcix.com/`` but could change over time
- ``CLOUDCIX_API_V2_URL``
- The API name is prepended to this url after the https:// for the Python3 API.
- Usually ``https://api.cloudcix.com/`` but could change over time
- ``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
.. code:: python
# In main python script
import os
os.environ.setdefault('CLOUDCIX_SETTINGS_MODULE', 'my_project.my_settings')
.. code:: python
# In my_project/my_settings.py
CLOUDCIX_API_URL = 'https://api.cloudcix.com/'
CLOUDCIX_API_V2_URL = CLOUDCIX_API_URL
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 <https://cloudcix.github.io/python-cloudcix/examples.html>`_ for examples on how to use this library.
Raw data
{
"_id": null,
"home_page": null,
"name": "cloudcix",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "CloudCIX SDK",
"author": null,
"author_email": "CloudCIX <developers@cloudcix.com>",
"download_url": "https://files.pythonhosted.org/packages/5f/88/26b8c224d085e28bdcbcaf80650ce8e86ef7396ad5272c1fb7a9af3a5645/cloudcix-0.13.11.tar.gz",
"platform": null,
"description": "Overview\n========\n\n``cloudcix`` is a Python client for the CloudCIX REST API for rapidly building secure, scalable CloudCIX applications.\n\nFor more information about CloudCIX, see `here <http://www.cix.ie/#/services/saas>`__.\n\nInstallation\n------------\n\nPrerequisites\n~~~~~~~~~~~~~\n1. Create an account on the CloudCIX Platform\n\n - `Register <https://saas.cloudcix.com/auth/register>`__\n\n2. Retrieve your API Key\n\n - Under the ``My Membership`` tab in the sidebar, click on ``Member Details``\n - The ``API Key`` should be available at the top of the form\n\n3. Ensure that you have both Python and pip installed\n\n - As of right now, the ``cloudcix`` module is available at different versions for Python2 and Python3\n - We recommend you use Python3 and the latest version of the ``cloudcix`` module\n - `Python <http://docs.python-guide.org/en/latest/starting/installation/>`__\n - `pip <https://pip.pypa.io/en/stable/installing/>`__\n\nInstalling the ``cloudcix`` library\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nThe cloudcix library is installed using the ``pip`` module.\n\nDepending on your version of Python, you need to install different versions of ``cloudcix``\n\n- Python3\n - ``pip3 install -U cloudcix``\n- Python2\n - ``pip install -U 'cloudcix<0.3'``\n\nThe 0.2 releases are the last to support Python2.\nIf you still use Python2 we recommend you upgrade to Python3 as support will be dropped for these versions in time.\n\nRequired settings\n~~~~~~~~~~~~~~~~~\nIn order to run a project, the module requires some settings to exist.\n\nThe variables required are as follows:\n\n- ``CLOUDCIX_API_URL``\n - The base url of the Python2 API\n - Usually ``https://api.cloudcix.com/`` but could change over time\n- ``CLOUDCIX_API_V2_URL``\n - The API name is prepended to this url after the https:// for the Python3 API. \n - Usually ``https://api.cloudcix.com/`` but could change over time\n- ``CLOUDCIX_API_VERSION`` = 2\n - The version of the api\n- ``CLOUDCIX_API_USERNAME``\n - The email of the account that you signed up with\n- ``CLOUDCIX_API_PASSWORD``\n - The password associated with your CloudCIX account\n- ``CLOUDCIX_API_KEY``\n - The API key associated with your CloudCIX Member (see **Prerequisites**)\n\nThese variables can be declared in a settings file, as follows\n\n.. code:: python\n\n # In main python script\n import os\n os.environ.setdefault('CLOUDCIX_SETTINGS_MODULE', 'my_project.my_settings')\n\n.. code:: python\n\n # In my_project/my_settings.py\n CLOUDCIX_API_URL = 'https://api.cloudcix.com/'\n CLOUDCIX_API_V2_URL = CLOUDCIX_API_URL\n CLOUDCIX_API_USERNAME = 'EMAIL' # CloudCIX login\n CLOUDCIX_API_PASSWORD = 'PASSWORD' # CloudCIX password\n CLOUDCIX_API_KEY = 'NUMBER/CHARACTER STRING' # CloudCIX api key\n CLOUDCIX_API_VERSION = 2 # CloudCIX version\n\nExamples\n--------\nSee `here <https://cloudcix.github.io/python-cloudcix/examples.html>`_ for examples on how to use this library.\n",
"bugtrack_url": null,
"license": "Copyright 2015 CloudCIX Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ",
"summary": "Python3 bindings and utils for CloudCIX API.",
"version": "0.13.11",
"project_urls": {
"Homepage": "https://python-cloudcix.readthedocs.io/en/latest/"
},
"split_keywords": [
"cloudcix",
"sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e79afbca09309d0f943704f88f315f9245ecc4496ae13fa249f464545a282a0a",
"md5": "fa01dcf644a4beec6466dd621e3317fa",
"sha256": "b3cf7460479c3d209a5854067910264a371b4495a4ee066eb5b69e562b61b914"
},
"downloads": -1,
"filename": "cloudcix-0.13.11-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa01dcf644a4beec6466dd621e3317fa",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 29530,
"upload_time": "2024-04-23T08:52:49",
"upload_time_iso_8601": "2024-04-23T08:52:49.497694Z",
"url": "https://files.pythonhosted.org/packages/e7/9a/fbca09309d0f943704f88f315f9245ecc4496ae13fa249f464545a282a0a/cloudcix-0.13.11-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5f8826b8c224d085e28bdcbcaf80650ce8e86ef7396ad5272c1fb7a9af3a5645",
"md5": "75457b35f3d9228def609fe718346d60",
"sha256": "c7aa535caaa49b692cc84d23b09b70bf4c7bff4ffc67c01b029a297777ed61b4"
},
"downloads": -1,
"filename": "cloudcix-0.13.11.tar.gz",
"has_sig": false,
"md5_digest": "75457b35f3d9228def609fe718346d60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 22375,
"upload_time": "2024-04-23T08:52:51",
"upload_time_iso_8601": "2024-04-23T08:52:51.825230Z",
"url": "https://files.pythonhosted.org/packages/5f/88/26b8c224d085e28bdcbcaf80650ce8e86ef7396ad5272c1fb7a9af3a5645/cloudcix-0.13.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 08:52:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cloudcix"
}
JSON