Releases: Cumulocity-IoT/cumulocity-python-api
Release 3.1.1
Release 3.1
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
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
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
- Fixing library dependencies
Release 2.1
- 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
v2.0.1 Fixed apidocs.
Release 2.0
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).
Release 1.10
- The
select
andget_all
functions now feature anexpression
parameter which allows to directly specify the entire REST API filtering expression. - Fixed, unified and streamlined the behavior or the
query
parameter within allselect
andget_all
functions. - The
apply_to
functions now allow to specify the to-be-applied changes directly in JSON. - Various tiny code and documentation improvements.
- Updated GitHub Actions to latest Node versions.
- Fixed build dependencies.
Release 1.9.2
- Testing code improvements.
- Added support for signed, shared and non-persistent Notification 2.0 subscriptions and tokens (Thanks @wilbersl!)
- Fixed audit record parsing.
- Various code and documentation improvements.
- Added support for token-based authentication for interactive sessions.
- Added
page_number
parameter to inventory queries to be able to pull a specific page. - Added
get_count
functions toinventory
API to estimate expected number of results. - Added
get_subscribers
function toMultiTenantCumulocityApp
.