Loqed Touch Smart Lock — Python client
This repository provides a small async-first Python client for the Loqed Touch smart lock. It wraps the HTTP API used by Loqed devices and exposes convenient helpers to read lock state, send lock/unlock commands, and manage webhooks.
Quick start
- Install the package (recommended: in a virtualenv):
Using uv (recommended):
uv venv
uv pip install -e .
Using pip:
python -m venv .venv
source .venv/bin/activate
pip install -e .
- Install dev/test dependencies (optional):
uv pip install -e ".[dev]"
or with pip:
pip install -e ".[dev]"
Note: quote
.[dev](as above) — in zsh, an unquoted.[dev]is interpreted as a glob pattern and fails withno matches found: .[dev].
- Use the client (async):
import asyncio
from loqedAPI.loqed import APIClient, LoqedAPI
async def main():
client = APIClient(base_url="https://api.loqed.com", token="your-api-token")
api = LoqedAPI(client)
# fetch a lock by id
lock = await api.async_get_lock("lock-id")
print("state:", lock.bolt_state)
# send an unlock command
await lock.unlock()
asyncio.run(main())
Notes:
- The library is async-first and uses
aiohttpfor HTTP calls. APIClientacceptsbase_urland an optionaltoken(for authorization) or you can provide your ownaiohttp.ClientSession.
Testing
Run the test suite with pytest (the project uses pytest-asyncio and aioresponses).
With uv (no need to activate the venv or pre-install anything — uv run syncs the
dev extra into an ephemeral environment automatically):
uv run --extra dev pytest --cov=src/loqedAPI --cov-report=term-missing
With pip/a manually activated venv:
source .venv/bin/activate
pytest --cov=src/loqedAPI --cov-report=term-missing
Development
- The package follows standard Python packaging with
pyproject.toml(version is derived from git tags viasetuptools-scm). - Dev/test dependencies are available under the
devextra:uv pip install -e ".[dev]"orpip install -e ".[dev]". - When editing code, run the tests frequently. The tests are fast and designed to mock network calls.
Contributing
If you want to contribute:
- Fork the repo, create a branch, and make your changes.
- Add or update tests for new behavior.
- Run the test suite and ensure all tests pass.
- Open a pull request with a short description of the change.
Releasing
Releases are built and published to PyPI automatically by a public GitHub Actions
workflow (.github/workflows/release.yml) — there is no manual/local publish step.
To cut a release:
- Draft a GitHub Release with a
tag in the form
vX.Y.Z(e.g.v2.1.12). - Publish the release. The package version is derived from the tag via
setuptools-scm, so the version on PyPI always matches a tagged commit in this repository. - CI runs the test suite, builds the sdist/wheel, and publishes to PyPI using PyPI Trusted Publishing (no stored API tokens).
Where to find docs
- Source code is under
src/loqedAPI. - Sphinx documentation lives in
docs/.
License
See the LICENSE file in the project root.
1 maintainer
Metadata
1 maintainer
Release files for loqedAPI 2.1.15
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| loqedapi-2.1.15.tar.gz | 157.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| loqedapi-2.1.15-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 168.2 kB
Release files / loqedapi-2.1.15.tar.gz
| Download URL | loqedapi-2.1.15.tar.gz |
|---|---|
| Size | 157.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d4590ad48b08e419e36f98b9ebf70e9bb5aad87fde4d4631ca7f06b064c673eb
|
|
BLAKE2b-256 checksum How to use checksums |
5c2340b4668c634234ffea8d4b206776734ff1e8928ded96918e9f8797776637
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 28, 2026.
Transparency logRelease files / loqedapi-2.1.15-py3-none-any.whl
| Download URL | loqedapi-2.1.15-py3-none-any.whl |
|---|---|
| Size | 11.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0b88f1dda0a1166f4498401e4a0dee01e1d6a47d040b10c35804959ea4bf89f2
|
|
BLAKE2b-256 checksum How to use checksums |
3ce5633cb85b228a2886e3f5925a25de2be2c79de0061fba9c849179ada6d775
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 28, 2026.
Transparency log
