Contents

Overview

docs Documentation Status
tests Travis CI Status Coveralls Coverage Status Codacy Code Quality Status
package PyPI Package latest release PyPI Package monthly downloads PyPI Wheel Supported versions

python-cloudcix is CloudCIX’s Python REST API client for rapidly building secure, scalable CloudCIX applications. For more information about CloudCIX visit http://www.cix.ie/services/cloudcix_saas/

Installation

pip install cloudcix

Development

To run the all tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows 
set PYTEST_ADDOPTS=--cov-append
tox
Other 
PYTEST_ADDOPTS=--cov-append tox

Installation

At the command line:

pip install cloudcix

Python Application

Create a settings module:

# settings.py
CLOUDCIX_AUTH_URL = 'https://keystone.cloudcix.com/v3'
CLOUDCIX_API_URL = 'https://api.cloudcix.com/'
CLOUDCIX_API_USERNAME = 'username'
CLOUDCIX_API_PASSWORD = 'yourpassword'
CLOUDCIX_API_ID_MEMBER = 'your_member_id'

you can find your member ID at https://saas.cloudcix.com/membership/setup/account/member/

and configure the Python environment:

# app.py

import os
os.environ['CLOUDCIX_SETTINGS_MODULE'] = 'settings'

Django Application

Add the same settings from the previous section in your Django settings module. python-cloudcix will import the settings using Django.

Usage

To use CloudCIX Rest API Client in a project:

from cloudcix import api

Reference

cloudcix

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Documentation improvements

CloudCIX Rest API Client could always use more documentation, whether as part of the official CloudCIX Rest API Client docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/cloudcix/python-cloudcix/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

To set up python-cloudcix for local development:

  1. Fork python-cloudcix (look for the “Fork” button).

  2. Clone your fork locally:

    git clone git@github.com:your_name_here/python-cloudcix.git

  3. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  4. When you’re done making changes, run all the checks, doc builder and spell checker with tox one command:

    tox

  5. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  6. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (run tox) [1].
  2. Update documentation when there’s new API, functionality etc.
  3. Add a note to CHANGELOG.rst about the changes.
  4. Add yourself to AUTHORS.rst.
[1]

If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request.

It will be slower though ...

Uploading to PyPI

rm -rf *.egg-info rm -rf build/ python setup.py sdist bdist_wheel upload

Tips

To run a subset of tests:

tox -e envname -- py.test -k test_myfeature

To run all the test environments in parallel (you need to pip install detox):

detox

Authors

Changelog

0.3.2 (2016-11-18)

  • Added Nmap service
  • Added some docstrings for api
  • Added NotImplemented to currently unused Active Directory authentication

0.3.1 (2016-11-08)

  • Removed Antenna client deprecated at the end of October
  • Added missing Circuit clients
  • Added missing domain, pool_ip and ipmi clients to dns
  • Added missing clients for circuit and plot
  • Added new bin and bin_sku clients to scm

0.3.0 (2016-11-04)

  • Major rewrite of code to be thin wrapper for requests
  • Removed python-keystoneclient dependency
  • Removed oslo.config dependency
  • Removed django dependency (still an optional integration)
  • Added 100% coverage unit tests using pytest
  • Added readthedocs online documentation
  • Added Travis CI continuous integration testing
  • Added Coveralls CI coverage report integration
  • Added Codecov CI code quality report integration
  • Improved README

Indices and tables