pyc8y 4.0.0a1__tar.gz

pyc8y-4.0.0a1/.gitattributes

@@ -0,0 +1 @@
+CHANGELOG.md merge=union

pyc8y-4.0.0a1/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '36 22 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

pyc8y-4.0.0a1/.github/workflows/lint.yml

@@ -0,0 +1,16 @@
+name: Lint
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v6.0.2
+    - name: Install uv
+      uses: astral-sh/setup-uv@v8.1.0
+      with:
+        python-version: '3.11'
+    - name: Run ruff
+      run: uv run ruff check src/pyc8y tests integration_tests samples

pyc8y-4.0.0a1/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+# Publishes pyc8y to PyPI via Trusted Publishing (OIDC) when a v* tag is pushed.
+# Setup:
+#   - PyPI: https://pypi.org/manage/account/publishing/ -> Add a pending publisher
+#     (project=pyc8y, repo=this repo, workflow=publish.yml, environment=pypi)
+#   - GitHub: Settings -> Environments -> create "pypi"
+
+name: Release
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6.0.2
+        with:
+          fetch-depth: 0  # hatch-vcs derives the version from the tag
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.1.0
+      - name: Install Python 3.13
+        run: uv python install 3.13
+      - name: Build
+        run: uv build
+      - name: Smoke test (wheel)
+        run: uv run --isolated --no-project --with dist/*.whl tests/smoke_test.py
+      - name: Smoke test (source distribution)
+        run: uv run --isolated --no-project --with dist/*.tar.gz tests/smoke_test.py
+      - name: Publish
+        run: uv publish

pyc8y-4.0.0a1/.gitignore

@@ -0,0 +1,14 @@
+.idea*
+.vscode*
+.pytest*
+__pycache__
+dist*
+build*
+*venv*
+*.egg-info
+.env*
+_version.py
+wordlist.txt
+.ipynb_checkpoints
+.coverage
+/site/

pyc8y-4.0.0a1/.readthedocs.yaml

@@ -0,0 +1,23 @@
+# Copyright (c) 2025 Cumulocity GmbH
+
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - filters
+        - pandas
+    - requirements: docs/requirements.txt
+
+mkdocs:
+  configuration: mkdocs.yaml

pyc8y-4.0.0a1/CHANGELOG.md

@@ -0,0 +1,473 @@
+# Changelog
+
+### Features
+
+* Migrated the entire library to `asyncio` using highly optimized `httpio` and `orjson` libraries under the hood.
+
+* All model objects are now fully based on and compatible to the actual JSON data. The pure JSON representation is 
+  available via the commonly available `json` property. Key fields (like `id`, or `creation_date` are still promoted
+  as class attributes, all other fragments can be read using the universal `get` function and `[]` operator.
+
+* Added `workers` parameter to most query-like functions (`select`, `get_all`, `delete_by`, ...) and bulk operations
+  (`create`, `update`, `apply_to`, `delete`, ...) to automatically perform the activities unordered and in parallel.
+
+* Added the `expression` parameter to all query-like functions (`select`, `get_all`, `delete_by`, ...) for consistency. 
+
+* Added `send_to` function to Operations API to send an operation to a collection of devices.
+
+* Added functions `get_tenant_options` and `get_current_tenant_options` to Applications API.
+
+
+### Breaking changes
+
+#### Major changes
+
+* The `c8y_api` and `c8y_tk` modules have been merged into a single `pyc8y` module which integrates pure API calls
+  with auxiliary functionality in a single, sound SDK design. The project name was changed to _Cumulocity Python SDK_
+  accordingly. The PyPI entry was changed to `pyc8y`.
+
+* The somewhat magic _dot notation_ access (`object.fragment.field`) has been removed to reduce complexity and increase
+  transparency. Custom fields and fragments can only be addressed using the index operator `[]` or the `get` function.
+  Both support  dot/path notation within (`object.get("fragment.field")` or `object["fragment.field"]`). The `get`
+  functions allows the definition of a proper default value whereas the `[]` index  operator will raise a `KeyError`
+  if any part of the specified path is not available.
+
+* Immutable lists. In any object read from Cumulocity lists/arrays are _considered_ immutable. To extend a list it 
+  needs to be overwritten. This is in conformance with Cumulocity's data model in which an attribute cannot be altered
+  but only overwritten with the new value resp. structure.
+
+* The module now being exclusively async, the `AsyncListener` and `AsyncQueueListener` have been renamed to `Listener`
+  and `QueueListener`. The synchronous variants have been dropped.
+
+* The `GlobalRole` class has been renamed to `UserGroup` to match the REST API naming.  TODO: global_roles API alias?
+  Likewise, the `permission_ids` property has been renamed to `role_ids`. `add_permissions` to `assign_roles` etc. 
+
+* The `level` attribute in the `Permission` class has been renamed to `permission` to match the JSON structure.
+
+* Inventory role assignments are not part of the `Users` class, moved from `InventoryRoles` because the API logically
+  belongs to users and role assignments cannot be created without a user reference. 
+
+* The `SubscriptionListener` listener implementation has been promoted to a standard component. It has been simplified
+  and converted to run async callbacks. It can be created from `MultiTenantCumulocityApp` using the `create_listener`
+  function. 
+
+Percentage -> Percent
+
+
+#### Minor changes
+
+* All ID are now required to be `string`s. Integers are no longer supported.
+
+* Default page size is now a reasonable 100 throughout the SDK. Also, a default limit of 5 is applied to ease use in
+  interactive ("quick grab") scenarios. Be sure to define proper limits and page sizes in production use.
+
+* Object-oriented `update` and `reload` now automatically update the `self` object as well. They feature a new `copy`
+  parameter to return a new instance and leave self as-is if needed.
+ 
+* Cumulocity objects featuring a last updated date: The Python attributes were renamed to 
+  `update_time`/`update_datetime` (previously `updated_time`/`updated_datetime`).
+
+* Throughout the SDK additional parameters to the constructors (`__init__`) and query-like functions (`select`,
+  `get_all`, `count`, etc.) now need to be named to enforce a better coding style and forward compatibility.  
+
+* The Identity classes' `create` and `delete` functions now also allow bulk creation/deletion to stay conform to the
+  rest of the model classes. Direct creation and deletion of an individual external ID therefor now requires named
+  parameters.
+
+* Auxiliary enumerations have been moved to be top-level classes and have been renamed accordingly: 
+  - `Operation.Status` to `OperationStatus` 
+  - `BulkOperation.Status` to `BulkStatus`, `BulkOperation.GeneralStatus` to `GeneralBulkStatus` 
+
+* In the tenant options API, functions `TenantOptions.delete_by` and `TenantOptions.update_by` are discontinued. Use
+  functions `delete` and `update_values` instead. The `get_all_mapped` function was optimized and replaced by function
+  `get_values`. 
+
+
+* The `UserG`
+
+* In the Binary API, the
+
+
+
+
+## Version 3.7.2
+
+* Switched to MkDocs for documentation.
+* Fixed [Issue #91](https://github.com/Cumulocity-IoT/cumulocity-python-api/issues/91) 
+* Fixed [issue #92](https://github.com/Cumulocity-IoT/cumulocity-python-api/issues/92)
+
+## Version 3.7.1
+
+* Adding `clear_tenant_cache` function to `MultiTenantCumulocityApp` to explicitly wipe unsubscribed tenants.
+* Fixed [Issue #87](https://github.com/Cumulocity-IoT/cumulocity-python-api/issues/87)
+
+## Version 3.7.0
+
+* Adding `aggregation_function` and `aggregation_interval` parameters to the `Measurements.get_series` function
+  to support the latest series aggregation features as described in the
+  [Cumulocity OpenAPI Documentation](https://cumulocity.com/api/core/#operation/getMeasurementSeriesResource).
+
+## Version 3.6.0
+
+* Fixed a bug in `get_count` for when _no_ additional filter parameter was provided.
+* Switching to `withTotalElements` instead of `withTotalPages` in `get_count` implementations.
+* Adding `select`, `get_all` and `get_count` functions to Binaries API and Operations API.
+* Adding `c8y_tk.analytics.parallel` module and `ParallelExecutor` class which can be used to reduce I/O wait
+  time through concurrent API requests and asynchronous result collection.
+
+## Version 3.5.1
+
+* Fixing imports for situations where client-side filtering libraries are not imported. The library supports
+  optional dependncy definitions: `c8y_api[filters]` to support all available filters, `c8y_api[pydf]`,
+  `c8y_api[jmespath]`, and `c8y_api[jsonpath]` to support PyDF, JMESPath or JSONPath accordingly.
+* Harmonizing page size and limit - the page size of a query should never exceed a given limit (as this would 
+  be pointless). This feature also allows just specifying the limit for a query, the page size will
+  automatically be adjusted.
+
+## Version 3.5.0
+
+* Added client-side filtering to many of the standard API (wherever sensibly applicable); These APIs `select`
+  and `get_all` functions now feature optional `include` and `exclude` parameters which can be used to filter 
+  the results before being wrapped into Python objects; Added multiple matchers including a JSONPath matcher
+  a JMESPath matcher and a PyDF (Python Display Filter) matcher with PyDF as default.
+
+## Version 3.4.0
+
+* Added `QueueListener` and `AsyncQueueListener` classes to the Notification 2.0 toolkit. These pre-defined
+  listener implementation append new notifications to standard queues that can be monitored/listened to which 
+  makes Notification 2.0 solutions even simpler to implement.
+* Updated and rewrote Notification 2.0 listener implementation. Added additional parameters for more control: 
+  `consumer_name`, `shared`, `auto_ack` and `auto_unsubscribe`. Added `unsubscribe` function for removing
+  subscribers on demand. Both `AsyncListener` and `Listener` now provide consistent `start`/`stop` functions
+  which take care of coroutine and thread creation. The `listen ` function can still be invoked directly if
+  necessary. 
+
+## Version 3.3.0
+
+* Added `get_by` function to inventory API to return a single object by query.
+* Added `CumulocityApp` class to module `c8y_tk.app` which allows working with Cumulocity interactively, e.g. in a
+  Jupyther notebook. It will deal with environment variables just like the other connection helpers but will also
+  ask interactively for missing info, e.g. a second factor with 2FA. It also integrates well with the
+  [c8y-go-cli](https://goc8ycli.netlify.app/) tool.
+* Added `c8y_tk.app` packages with `SubscriptionListener` class to ease development of multi_tenant microservices
+  which need to act on all subscribed tenants or on added/removed subscriptions alike.
+* Adding debug logs to base API as default urllib3 logs are not helpful for our purpose.
+* Single and multi tenant applications now automatically set the `application_key` property from the standard
+  `APPLICATION_KEY` environment variable. 
+* Added `get_count` function to `Operations` API.
+* Added `as_values` parameter to `get_all` and `select` functions of the Inventory, DeviceInventory,
+  DeviceGroupInventory, Events, Alarms, Users, Operations, and AuditRecords API.
+* Added code coverage reporting to `test` target for _invoke_.
+* Updated `as_tuple` for  complex objects as well as the `as_values` parameter for `select`
+  and `get_all` functions to work with strings or 2-tuples. The use of a dictionary
+  was removed as dictionaries don't define an order.
+* Added `as_values` parameter to the Measurements API `select` and `get_all` functions.
+* Adding `c8y_tk.analytics` package with `to_numpy`, `to_series` and `to_data_frame` functions to
+  ease incorporating Cumulocity data into standard analytics pipelines.
+  
+## Version 3.2.1
+
+* Some essential fixes and improvements for dealing with measurements and series.
+
+## Version 3.2
+
+* 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. 
+* 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 `__repr__` function to relevant object classes.
+* Removed redundant `util.py` file which impeded importing.
+
+## Version 3.1.1
+
+* Fixing project dependencies for older Python versions.
+
+## Version 3.1
+
+* 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')`.
+
+## Version 3
+
+* Unified query behaviour of all API classes (introducing potentially breaking changes as the order of parameters needed to change).
+* Added support for arbitrary expressions and kwargs on almost all select functions defined at the API classes, e.g. for Measurements, Events, Alarms, Inventory, etc. Using the expression parameter (always the first in all select-like functions that support it), an arbitrary query expression can be defined which will be forwarded to the REST API as-is. Using kwargs, additional maybe undocumented or deprecated parameters can be defined.
+* Additional, undocumented select parameters will automatically be converted to Pascal case (e.g. my_undocumented_arg will be translated to myUndocumentedArg).
+* 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](https://github.com/Cumulocity-IoT/cumulocity-python-api/issues/63) (tenant option select function did not filter categories correctly).
+
+
+## Version 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
+
+
+## Version 2.0
+
+* 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; this is a breaking change as some functions moved from the User API
+  to the CurrentUser API (the correct place).
+* 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. 
+
+
+## Version 1.10
+
+* The `select` and `get_all` functions now feature an `expression` parameter which allows to directly specify the entire REST API filtering expression.
+* Fixed, unified and streamlined the behavior or the `query` parameter within all `select` and `get_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.
+
+
+## Version 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 to inventory to estimate expected number of results.
+* Added get_subscribers function MultiTenantCumulocityApp.
+
+
+## Version 1.9.1
+
+* Minor improvements and fixes.
+* Added possibility to pull a specific result page to all `select` and `get_all` functions.
+
+
+## Version 1.9.0
+
+* Added support for inventory endpoints `/availability`, `/supportedMeasurements` and `/supportedSeries`.
+
+* Added `Units` class to support explicit modelling of measurement fragments.
+
+* Added support for the Current Application API (current application settings, current application subscriptions).
+
+* Added test fixture (`app_factory`)to `conftest.py` to register (and automatically unregister) a dedicated
+  microservice application for advanced integration testing. 
+
+* Making websocket ping interval explicit and updating it to 60 seconds by default.
+
+
+## Version 1.8.2
+
+* Bumped flask from 2.2.2 to 2.3.2 (vulnerability)
+
+  Bumped python-dateutil from 2.8.1 to 2.8.2 (pandas requirement)
+
+* Added `is_tls` property to `CumulocityRestApi` class;
+
+  fixed secure protocol handling for Notification2 websocket connections.
+
+* Microservice build support improvements.
+
+
+## Version 1.8.1
+
+* Fixed series value collection for incomplete series.
+
+
+## Version 1.8
+
+* Adding support for measurement series queries.
+
+## Version 1.7
+
+* Adding support for the Audit API.
+
+* Added support for event attachment handling.
+
+* Adding support for bulk operations.
+
+## Version 1.6.1
+
+* Adding `c8y_tk` namespace to distribution.
+ 
+## Version 1.6
+
+* Added API support for Notification 2.0 subscriptions and tokens.
+ 
+* Added new package c8y_tk for additional features.
+ 
+* Added synchronous and asynchronous Notification 2.0 websocket listener,
+  Added two (async/sync) Notification 2.0 samples.
+
+## Version 1.5
+
+* Improved Applications API.
+
+* Added microservice utilities for easier testing of provided samples.
+
+* Added Tenant Options API support.
+
+## Version 1.4
+
+* Fixed https://github.com/SoftwareAG/cumulocity-python-api/issues/25
+  The SimpleTenantApp did not include the tenant ID into the username which is not supported 
+  by all Cumulocity instances.
+
+* Adding class _QueryUtil, bundling query encoding related functionality.
+
+* Added tests for special character parsing.
+
+* Fixed handling and documentation of inventory API for querying by name. 
+  Added query parameter for specification of custom queries.
+
+* Reverted changes in ComplexObject - a ComplexObject is not a dictionary-like class, it only   
+  supports some dictionary-like access functions. But, for instance, updating a ComplexObject
+  is very different from updating a dictionary. Hence, it no longer inherits MutableMapping.
+
+## Version 1.3.2
+
+### Changed
+
+* Obfuscated internal properties in _DictWrapper which blocked standard dictionary behavior. 
+  Code cleanup.
+
+* ComplexObject & _DictMapping now both inherit MutableMapping (Thanks Sam!).
+
+* The base API now ignores trailing slashes gracefully.
+
+
+## Version 1.3.1
+
+### Changed
+
+* Switched to version 2.4.0 of PyJWT as recommended by https://nvd.nist.gov/vuln/detail/CVE-2022-29217 
+
+
+## Version 1.3
+
+### Changed
+
+* All objects with fragments can now be converted to Pandas Series (Thanks Sam!).
+
+### Added 
+
+* Added support for operations (Thanks Alex!).
+
+* Added support for lastUpdated field in alarms and events.
+
+
+## Version 1.2
+
+### Changed
+
+* Changed behavior of Events and Alarms API. Previously, an undefined event/alarm time was set to the current datetime 
+  when invoking the `.create` function on the object. This was handy but inconsistent to the REST API behavior and
+  therefore removed. Instead, the constructor can now be invoked with `time='now'` as a shorthand. The `time` field
+  is never set to a default value automatically.
+
+* Added `samples` folder to linting task.
+
+* Added device agent registration sample (Thanks Nick!).
+
+
+## Version 1.1.1
+
+### Added
+
+* Added Multi-Tenant sample script (`samples/multi_tenant_app.py`).
+
+* Added task `build-ms` task and corresponding script files to generate Cumulocity microservices from sample scripts.
+
+### Fixes
+
+* Fixed authentication (username must include tenant ID) for subscribed tenants in multi-tenant scenarios. 
+
+* Fixed pylint dependency in `requirements.txt`.
+
+* Added `cachetools` to library dependencies in `setup.cfg`.
+
+
+## Version 1.1
+
+### Notes
+
+* _Warning_, this release is a breaking change as it introduces an `auth` parameter to the API base classes,
+  `CumulocityRestAPI` and `CumulocityAPI`. This parameter should be the new standard to use (instead of just
+  username and password).
+
+* _Warning_, this release replaces the 'all-purpose' class `CumulocityApp` with specialized versions for multi-tenant
+  (`MultiTenantCumulocityApp`) and single tenant (`SimpleCumulocityApp`) environments.
+
+### Added
+
+* Added `_util.py` file to hold all cross-class auxiliary functionality.
+
+* Added `_auth.py` file to hold all cross-class authentication functionality. Moved corresponding code from file
+  `app.__init__.py` to the `AuthUtil` class.
+ 
+* Added `_jwt.py` with `JWT` class which encapsulates JWT handling for the libraries purpose. This is _not_ a full
+  JWT implementation. 
+
+* Added `HTMLBearerAuth` class which encapsulates Cumulocity's JWT token-based authentication mechanism. 
+ 
+* Added token-based authentication support. All API classes now can be initialized with an AuthBase parameter which
+  would allow all kinds of authentication mechanisms. As of now, `HTTPbasicAuth` and `HTTPBearerAuth` is supported.
+
+* Added caching with TTL/Max Size strategies to `MultiTenantCumulocityApp` and `SimpleCumulocityApp`.
+
+* Added samples: `user_sessions.py` illustrating how user sessions can be obtained and `simple_tenant_app.py` 
+  illustrating how the `SimpleCumulocityApp` class is used.
+
+* Added requirements: `cachetools` (for caching), `inputtimeout` and `flask` (for samples).
+
+### Changed
+
+* Fixed file opening in `post_file` function in `_base_api.py` to avoid files already being closed when posting.
+
+* Removed class `CumulocityApp` as it was too generic and hard to use. Replaces with classes `SimpleCumulocityApp`
+  which behaves pretty much identical and `MultiTenantCumulocityApp` which behances more like a factory.
+
+
+## Version 1.0.2
+
+### Changed
+
+* Added this changelog :-)
+
+* Fixed [Issue #7](https://github.com/SoftwareAG/cumulocity-python-api/issues/7):
+  Improved caching and user experience when creating CumulocityApp instances. Added unit tests.
+
+* Added possibility to resolve the tenant ID from authorization headers (both `Basic` and `Bearer`).
+
+
+## Version 1.0.1
+
+### Changed
+
+* The cumulocity-pyton-api library is now available on [PyPI](https://pypi.org) under the name `c8y_api` (see https://pypi.org/project/c8y-api/) 
+* Updated README to reflect installation from PyPI 
+
+
+## Version 1.0
+
+Major refactoring of beta version:
+* Unified user experience
+* Complete documentation
+* Performance improvements
+* Introduced `CumulocityApp` to avoid mix-up with `CumulocityApi`
+* Complete unit tests
+* Structured integration tests
+* Removed samples (sorry, need to be re-organized)