cumulocity-python-sdk

This project is a Python client for the Cumulocity REST API to make it easier to develop programs, scripts, device agents or microservices in Python.

See also the documentation on Read the Docs.

🚨 Important The pyc8y package is the successor of the c8y_api package - re-envisioned and reimplemented for asyncio. You can continue to use c8y_api for legacy code which will still receive important fixes for some time.

Installation

Prerequisites

Before installing the module (or any module for that matter) consider creating a virtual environment for your project. This is generally preferred over installing modules and dependencies globally:

cd <project-root>
python3 -m venv venv
source venv/bin/activate

Alternatively, using uv:

uv venv

Installation from PyPI

The recommended way is to install the lastest distribution package directly from the Python Package Index (PyPI). You can either add pyc8y as a dependency to your project using pyproject.toml, requirements.txt or just install it manually:

pip install pyc8y  #  when using venv/pip
uv add pyc8y       # when using uv

Manual installation

Alternatively, you can clone the repository. The module sources can be used directly within your Python 3 project. Simply copy the src/pyc8y folder to your sources root and install the requirements by running the following command:

pip3 install src/pyc8y

If the src folder is in your sources root folder all imports should work right away. Alternatively you can add pyc8y to your PYHTONPATH:

export PYTHONPATH=<project-root>/src/pyc8y; $PYTHONPATH

Licensing

This project is licensed under the Apache 2.0 license - see https://www.apache.org/licenses/LICENSE-2.0

These tools are provided as-is and without warranty or support. They do not constitute part of the Cumulocity product suite. Users are free to use, fork and modify them, subject to the license agreement. While Cumulocity GmbH welcomes contributions, we cannot guarantee to include every contribution in the master project.

You can find additional information in the Cumulocity Developer Community.