Skip to main content

GitHub TOML Python Version GitHub release (latest public by date) ReadTheDocs

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.

Metadata

Release files for pyc8y 4.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyc8y 4.1.0
File Size Uploaded Provenance Actions
pyc8y-4.1.0.tar.gz 401.6 kB Without provenance Details for pyc8y-4.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyc8y 4.1.0
File Interpreter ABI Platform Actions
pyc8y-4.1.0-py3-none-any.whl Python 3 none any Details for pyc8y-4.1.0-py3-none-any.whl

Total release size: 529.1 kB

Release files / pyc8y-4.1.0.tar.gz

Download URL pyc8y-4.1.0.tar.gz
Size 401.6 kB
Tags Source
SHA-256 checksum
How to use checksums
8b483f5cf1ed58fb1b61b6b4800e3a682bc9d258555556a162ce41a4d3c57eda
BLAKE2b-256 checksum
How to use checksums
52482ea0592bd74d6e82bb45e4db85cebb0f814565dc3830e3640af018bec724
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / pyc8y-4.1.0-py3-none-any.whl

Download URL pyc8y-4.1.0-py3-none-any.whl
Size 127.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2acaf84dd3048b225f4d1442d85328ee3d1facf666f0eb12138f31bcf13dd3d8
BLAKE2b-256 checksum
How to use checksums
ca620a53324c1a41ce34adab4d792735caf4387b42f69c32d6c60e6012b451fa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for pyc8y 4.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page