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.
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
The recommended way is to install the lastest distribution package directly from the Python Package Index (PyPI). You can either add c8y_api as a dependency to your project using setup.cfg, or install it manually:
pip install c8y_api
Releases are also archived within the GitHub releases page. The module is released as standard Python wheel (.whl file). It can be downloaded and installed using pip using the following command:
pip install <release wheel file>
Like installing from PyPI, this will install all necessary dependencies automatically. For your reference, the module's dependencies are also listed in file requirements.txt.
Alternatively, you can clone the repository. The module sources can be used directly within your Python 3 project. Simply copy the c8y_api folder to your sources root and install the requirements by running the following command:
pip3 install -r requirements.txt
The requirements.txt file is part of the sources.
If the c8y_api folder is in your sources root folder all imports should work right away. Alternatively you can add c8y_api to your PYHTONPATH:
export PYTHONPATH=<project-root>/c8y_api; $PYTHONPATH
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 Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project.
You can find additional information in the Software AG TECHcommunity. There is also an introductory article (Getting started with the Cumulocity Python API) available.
Contact us at TECHcommunity if you have any questions.
FAQs
Python microservice and application client for the Cumulocity REST API
We found that c8y-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.