CTERA for Python

https://travis-ci.com/ctera/ctera-python-sdk.svg?branch=master https://github.com/ctera/ctera-python-sdk/workflows/CI/badge.svg [Latest Release Documentation] https://snyk.io/test/github/ctera/ctera-python-sdk/badge.svg [Latest Release Version] PyPI - Wheel [Latest Release License] [Latest Release Supported Python Versions] [Latest Release Development Stage]

A Python SDK for integrating with the CTERA Global File System API. Compatible with Python 3.5+.

Documentation

User documentation is available on Read the Docs.

Installation

Installing via pip:

$ pip install cterasdk

If you receive a certificate error, add the following trusted hosts:

$ pip install cterasdk --trusted-host pypi.org --trusted-host files.pythonhosted.org  # [SSL: CERTIFICATE_VERIFY_FAILED]

Installation via proxy:

$ pip install cterasdk --proxy http://user:password@proxyserver:port  # use proxy

Install from source:

$ git clone https://github.com/ctera/ctera-python-sdk.git
$ cd ctera-python-sdk
$ python setup.py install

Importing the Library

After installation, to get started, open a Python console:

>>> from cterasdk import *

Building Documentation

Documentation can be compiled by running make html from the docs folder. After compilation, open docs/build/html/index.html.

Testing

We use the tox package to run tests in Python 3. To install, use pip install tox. Once installed, run tox from the root directory.

$ tox