Skip to main content

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.

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

  1. Checkout the repository (or a specific version)
  2. Run uv sync --extra docs --frozen
  3. Run uv run --frozen mkdocs serve while standing in the project root.

MimLink protocol schema sync

Most developers do not need this. The generated envelope_pb2.py is committed to the repository. This section is only relevant when syncing envelope.proto from 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:

  1. Replace src/pyglaze/mimlink/proto/envelope.proto from upstream.
  2. Run ./scripts/generate_mimlink_proto.sh.
  3. Commit the updated envelope_pb2.py.
  4. 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!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyglaze-1.2.1.tar.gz (53.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyglaze-1.2.1-py3-none-any.whl (61.6 kB view details)

Uploaded Python 3

File details

Details for the file pyglaze-1.2.1.tar.gz.

File metadata

  • Download URL: pyglaze-1.2.1.tar.gz
  • Upload date:
  • Size: 53.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.21

File hashes

Hashes for pyglaze-1.2.1.tar.gz
Algorithm Hash digest
SHA256 f8ca3d24ac47907c936311a74410abfdaa66778daa2173373e6ff3734ba440d2
MD5 a94a69f84505ccf7930ee82787b3fb47
BLAKE2b-256 2de7c904cc41291e06954a548faabbdebe7756e676489f2412bd5405720c9760

See more details on using hashes here.

File details

Details for the file pyglaze-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: pyglaze-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 61.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.21

File hashes

Hashes for pyglaze-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6926c6128b66299a1f0c1c1e2ace2224da6bcd772cb08c607dc63a5d029a3e39
MD5 2e49768950229a4d752cedf03872c184
BLAKE2b-256 dfac57ac989d83f7bccf61df55961ccf4ad38817d6cfb2b7066ddf7a82d6d502

See more details on using hashes here.

Release history Release notifications | RSS feed

1.8.3

2 files

1.8.2

2 files

1.8.1

2 files

1.8.0

2 files

1.3.0

2 files

1.2.2

2 files

This release

1.2.1 This release

2 files

1.1.0

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page