CTERA SDK for Python

The CTERA SDK for Python provides developers with powerful tools to automate the deployment and configuration of the CTERA Global File System, streamline data management tasks, and seamlessly integrate CTERA's global namespace with their applications.

Documentation

User documentation is available on Read the Docs.

Installation

Installing via pip:

$ pip install cterasdk

Install from source:

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

Importing the Library

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

Compatibility Notice

Future versions of the CTERA Python SDK may introduce breaking changes. A breaking change is any modification insupported functionality between released versions that may require users to update existing integrations or configurations to upgrade successfully. While efforts are made to minimize disruption, such changes are sometimes necessary to maintain and improve the software.

Notice of breaking changes will be detailed in the CTERA Python SDK changelog. Users are responsible for reviewing the changelog for each new version and thoroughly testing the software before deploying it in production.

By using the CTERA Python SDK, users acknowledge and agree that the SDK and its contributors are not liable for any damages, losses, or issues arising from the use or upgrade of the software, including those resulting from breaking changes.