Pyglaze
Pyglaze is a python library used to operate the devices of Glaze Technologies.
Documentation can be found here.
Installation
To install the latest version of the package, simply run
pip install pyglaze
Usage
See our documentation for usage.
pyglaze expects device firmware that reports MimLink
operational_state and config_status_reason. Devices that omit those
fields are unsupported.
Firmware Updates
Pyglaze supports firmware updates over MimLink via FirmwareUpdater.
- Guide: Firmware Updates
- API:
pyglaze.device.FirmwareUpdater
Note: pyglaze expects a pre-signed MCUboot image and does not sign firmware itself.
Developers
To install the API with development tools, first clone the repository from our public GitHub repository. Then, from the root of the project, run
uv sync --extra dev --group security --frozen
Run commands through uv run so they use the locked environment:
uv run --frozen pytest
uv run --frozen ruff check .
uv run --group security --frozen pip-audit --strict
Documentation - local build
To build and serve the documentation locally
- Checkout the repository (or a specific version)
- Run
uv sync --extra docs --frozen - Run
uv run --frozen mkdocs servewhile standing in the project root.
MimLink protocol schema sync
Most developers do not need this. The generated
envelope_pb2.pyis committed to the repository. This section is only relevant when syncingenvelope.protofrom the upstream MimLink repo.
pyglaze vendors the MimLink protobuf schema in
src/pyglaze/mimlink/proto/envelope.proto. Python codegen is handled by
buf, which must be installed
separately (e.g. brew install bufbuild/buf/buf). Code generation uses
buf remote plugins (pinned in buf.gen.yaml), so no local protoc
install is required.
When syncing with upstream MimLink:
- Replace
src/pyglaze/mimlink/proto/envelope.protofrom upstream. - Run
./scripts/generate_mimlink_proto.sh. - Commit the updated
envelope_pb2.py. - Run protocol tests:
uv run pytest tests/mimlink/.
Bug reporting or feature requests
Please create an issue here and we will look at it ASAP!
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyglaze-1.1.0.tar.gz.
File metadata
- Download URL: pyglaze-1.1.0.tar.gz
- Upload date:
- Size: 50.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.10.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ac1237ff8b197b7b393d2fe57ee25b1a8f2e60fb71dc01e56c06d6c1321b182c
|
|
| MD5 |
11170ed458319f47fd705b8f7975da2a
|
|
| BLAKE2b-256 |
ae823ddc0936a7968a1df8877004ecff54f45459adff8fd0d6be8e3e4cd4f3b6
|
File details
Details for the file pyglaze-1.1.0-py3-none-any.whl.
File metadata
- Download URL: pyglaze-1.1.0-py3-none-any.whl
- Upload date:
- Size: 59.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.10.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d9634a805f70ad7759ab1c73a97e5711354cdd4c06acaf7314eb63093b317a9b
|
|
| MD5 |
d50d9657bc51c516873dcc69e1034238
|
|
| BLAKE2b-256 |
3aeadb1c1816153ab81cf8f13527e8c6042431ecdcd44dd5ec4139e1fb796e36
|
