Python API wrapper for the UC Integration API
This library simplifies writing Python-based integrations for the Unfolded Circle Remote devices by wrapping the WebSocket Integration API and supporting the available entities.
Not yet supported:
- Secure WebSocket
- Token-based authentication
Requirements:
- Python 3.11 or newer
Integrations using this library:
Installation
Use pip:
pip3 install ucapi
See examples directory for some minimal integration driver examples.
Environment Variables
Certain features can be configured by environment variables:
| Variable | Values | Description |
|---|---|---|
| UC_CONFIG_HOME | directory path | Configuration directory to save the user configuration from the driver setup. Default: $HOME or current directory |
| UC_INTEGRATION_INTERFACE | address | Listening interface for WebSocket server. Default: 0.0.0.0 |
| UC_INTEGRATION_HTTP_PORT | number | WebSocket listening port. Default: port field in driver metadata json file, if not specified: 9090 |
| UC_MDNS_LOCAL_HOSTNAME | hostname | Published local hostname in mDNS service announcement. Default: short hostname with .local domain. |
| UC_DISABLE_MDNS_PUBLISH | true / false |
Disables mDNS service advertisement. Default: false |
Versioning
We use SemVer for versioning. For the versions available, see the tags and releases on this repository.
Changelog
The major changes found in each new release are listed in the changelog and under the GitHub releases.
Contributions
Please read our contribution guidelines before opening a pull request.
License
This project is licensed under the Mozilla Public License 2.0. See the LICENSE file for details.
1 maintainer
Metadata
1 maintainer
Release files for ucapi 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ucapi-0.7.0.tar.gz | 68.9 kB | Without provenance | Details for ucapi-0.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ucapi-0.7.0-py3-none-any.whl | Python 3 | none | any | Details for ucapi-0.7.0-py3-none-any.whl |
Total release size: 129.0 kB
Release files / ucapi-0.7.0.tar.gz
| Download URL | ucapi-0.7.0.tar.gz |
|---|---|
| Size | 68.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4c182dd12c4e5245d43ceb5547c52cdca9ce41b91effca41c67d20eb864b1f69
|
|
BLAKE2b-256 checksum How to use checksums |
08ef121c1fc9df3383a40362df17a29e36fa7dc5d7916a7b93fb5e6bbc8ce323
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / ucapi-0.7.0-py3-none-any.whl
| Download URL | ucapi-0.7.0-py3-none-any.whl |
|---|---|
| Size | 60.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e85707a91f73d9709ddb6ac8d1fcbc356686fd0fd09a4396e8206c4b4c13d281
|
|
BLAKE2b-256 checksum How to use checksums |
b5c86a0e799cc17948f50861ce59909823a9c243cb9389acf575cb992488217a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Security for ucapi 0.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
