uunIot Framework

The uunIoT Framework is a library primarily for use with Unicorn uuApp server, however it can be used as a standalone. It provides functionality frequently needed in IoT applications such as dynamic configuration, events, persistence and basic telemetry, if needed.

for newest information and documentation, see UuBookKit
for quick start, see examples/ folder inside this repository and Getting started in the aforementioned BookKit.

Documentation

the code is self-documented, meaning that documentation can be automatically generated from comments in the code and the code itself via Sphinx.
the documentation needs to be generated first. To do this, first install Sphinx and then install the ReadTheDocs theme and cd docs && make html. Documentation for users is located in docs and for developers in docs-dev. The two differ mostly only in showing private class members (names starting with an underscore _).
see Sphinx documentation in docs and docs-dev for user and library-developer documentation respectively. After building, the HTML output is present in build/html subdirectories.

Example snippets are located in examples directory. Further examples can be found in applications built with uun-iot, such as uun-weatherstation, uun-guardman, uun-livecam or uu-fvekit.

For developers

Testing

create virtual environment for all uun applications, if you want to test your local version of library, otherwise create separate environments for each application and the library
- python3 -m venv env
- . env/bin/activate
- cd to library directory (directory where is setup.py)
- pip3 install -e .
- cd to application directory
- pip3 install -e .
- install pytest pip3 install pytest
- reactivate environment deactivate && . env/bin/activate
cd to main repository directory of the project you want to test and run pytest
pytest --log-cli-level=DEBUG for additional information and with lib logger output
testing involves
- static phase - test basic observations that should hold about the structure of certain objects
- dynamic phase - try modules' functionality: heartbeat and config updating
  - config updating can be turned on/off in tests/conftest.py, also be sure to introduce change in server configuration with respect to config file tests/config.json

Versioning

0.#.#
- initial releases changing rapidly

Release files for uun-iot 0.12.14

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

Source distribution (sdist)

Source distribution for uun-iot 0.12.14
File	Size	Uploaded
uun_iot-0.12.14.tar.gz	49.0 kB	May 21, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for uun-iot 0.12.14
File	Interpreter	ABI	Platform	Reset
uun_iot-0.12.14-py3-none-any.whl 56.6 kB May 21, 2025	Python 3	none	any	Details

Total release size: 105.7 kB

Release files / uun_iot-0.12.14.tar.gz

Download URL	uun_iot-0.12.14.tar.gz
Size	49.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`9ae7790c0b5c0f6feaca7ab08c3ef8bde6c2b9f01414a80bb2167e8842694506`
BLAKE2b-256 checksum How to use checksums	`e91bc375e6ab1eafafa77ece0aa5e23a88b37757f5e8a4afce4a648cbb1494d2`
Upload date	May 21, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.11.1`

Release files / uun_iot-0.12.14-py3-none-any.whl

Download URL	uun_iot-0.12.14-py3-none-any.whl
Size	56.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`918f9dc2748c0d33293af8c6d3fb8c6aafff5b942948c70e7db68addd7b352fa`
BLAKE2b-256 checksum How to use checksums	`a86cd00c4767f8632cbef737ff8075cf19a1d9eb1f6f30c72e9e19d21a99e916`
Upload date	May 21, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.11.1`