Skip to content

Releases: Cumulocity-IoT/cumulocity-python-api

Release 3.2.1

05 Mar 17:49

Choose a tag to compare

Some essential fixes and improvements for dealing with Measurements and Series.

Release 3.2

24 Feb 09:52

Choose a tag to compare

Version 3.2 features major usability improvements:

  • Added __repr__ function to relevant object classes to ease development and debugging
  • Added reload function to inventory object classes
  • Added delete_tree function to inventory object classes, implicitly using cascade or
    forceCascade parameters depending on the use case.
  • Added a as_tuple function to all complex objects which can be used to extract multiple nested values
    as a tuple using path-like expressions (complementing the generic get function).
  • Added as_tuples parameter to select and get_all functions in all inventory API as well
    as Events and Alarms API. This parameter can be used to directly extract specific values from
    the results instead of parsing the JSON.

Release 3.1.1

04 Feb 12:40
704a651

Choose a tag to compare

Merge pull request #66 from Cumulocity-IoT/feature/python37-support

Feature/python37 support

Release 3.1

04 Feb 12:31
704a651

Choose a tag to compare

Broad Python version support & improved fragment access

  • Adding support for Python 3.7 as this is still widely used in the industry. New code can now safely used with Python 3.7 throughout Python 3.13. Added invoke task for docker-based tests with different Python versions.
  • Greatly improved dot notation access to all complex Cumulocity objects (Managed Objects, Events, Alarms, Operations, etc.) This now also supports mixed access, e.g. obj.fragment[3].sub["name"].
  • Publicly releasing a generic get function to complex objects which allows accessing a nested value without the need to check for null values, e.g. obj.get('fragment.sub.name', default='N/A').

Release 3.0.1

21 Nov 18:30

Choose a tag to compare

Fixed packaging in version. 3.0.1

Major release as there are potentially some breaking changes.

This release improves heavily on selecting/filtering for all available sub APIs (Events, Alarms, etc.). All select-like functions now feature an expression argument (always the first argument so it can safely be used unnamed). If this argument is defined, its value is used as-is within the respective REST requests to the API. Developers can use this to fine-tune filter parameters as desired. Additionally, most select-like functions support adding kwargs which are added to the query as well. These options are automatically converted from Python's snake_case to Cumulocity's pascalCase.

Other changes:

  • Incorporated pull request to remove dependency on deprecated pkg_resources package (thanks @reubenmiller).
  • Incorporated pull request to support context handlers.
  • Many additional unit tests and integration tests.
  • Fixed issue #63 (tenant option select function did not filter categories correctly).

Release 3.0.0

21 Nov 13:01

Choose a tag to compare

Major release as there are potentially some breaking changes.

This release improves heavily on selecting/filtering for all available sub APIs (Events, Alarms, etc.). All select-like functions now feature an expression argument (always the first argument so it can safely be used unnamed). If this argument is defined, its value is used as-is within the respective REST requests to the API. Developers can use this to fine-tune filter parameters as desired. Additionally, most select-like functions support adding kwargs which are added to the query as well. These options are automatically converted from Python's snake_case to Cumulocity's pascalCase.

Other changes:

  • Incorporated pull request to remove dependency on deprecated pkg_resources package (thanks @reubenmiller).
  • Incorporated pull request to support context handlers.
  • Many additional unit tests and integration tests.
  • Fixed issue #63 (tenant option select function did not filter categories correctly).

Release 2.1.4

11 Oct 05:45

Choose a tag to compare

  • Fixing library dependencies

Release 2.1

09 Oct 08:34
70d1099

Choose a tag to compare

  • Added support for processing mode on all API base classes
  • Added support for Cookie-based auth on OAI-only tenants
  • Added latest extensions for Notification 2.0 API including count function.
  • Switch to Python version 3.10

Release 2.0.1

08 Aug 14:56

Choose a tag to compare

v2.0.1

Fixed apidocs.

Release 2.0

01 Aug 15:47

Choose a tag to compare

This version adds a few long missing features.

  • Added Changes support to the Audit API.
  • Fixed Issue #53 "KeyError when retrieving 'bulkOperation'"; bulk operations JSON is somewhat non-standard as
    the root element is not named like the corresponding REST resource.
  • Added proper support for the CurrentUser API
  • Added support for 2FA at user level; TFA/TOTP can be enabled for individual users. Parts of this functionality,
    e.g. getting the TOTP secret are only available at the CurrentUser level
  • Adding traditional date filter parameter names (date_from and date_to in addition to before/after) to Events
    and Alarms API.

The change in the User/CurrentUser API are breaking code changes (client code might need to be refactored).