loqedAPI 2.1.10__tar.gz → 2.1.14__tar.gz

loqedapi-2.1.14/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: python -m pip install --upgrade pip && pip install -e .[dev]
+
+      - name: Run tests
+        run: pytest --cov=src/loqedAPI --cov-report=term-missing

loqedapi-2.1.14/.github/workflows/release.yml

@@ -0,0 +1,64 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: python -m pip install --upgrade pip && pip install -e .[dev]
+
+      - name: Run tests
+        run: pytest
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tooling
+        run: python -m pip install --upgrade pip build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # required for PyPI trusted publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

loqedapi-2.1.14/.gitignore

@@ -0,0 +1,47 @@
+# Ignore Python cache and build artifacts
+/.eggs/
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+*.egg-info/
+dist/
+build/
+*.egg
+*.log
+*.sqlite3
+*.db
+
+# Ignore virtual environments
+.venv/
+venv/
+ENV/
+
+# Ignore test and coverage outputs
+.coverage
+htmlcov/
+.cache/
+.pytest_cache/
+
+# Ignore documentation build
+/docs/_build/
+
+# Ignore IDE/editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Ignore OS files
+.DS_Store
+Thumbs.db
+
+# Ignore all files except source
+!/src/
+!/tests/
+!/docs/
+!/.github/
+!/pyproject.toml
+!/LICENSE
+!/README.md
+!/pytest.ini

loqedapi-2.1.14/.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Current File",
+            "type": "python",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "env": { "PYTHONPATH": "./src"},
+            "justMyCode": true
+        },
+        {
+            "name": "Python: Module",
+            "type": "python",
+            "request": "launch",
+            "module": "tests.",
+            "cwd": "${workspaceRoot}",
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}/src/"
+            },
+            "envFile": "${workspaceRoot}/.venv",
+            "justMyCode": true
+        }
+    ]
+}

loqedapi-2.1.14/.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

loqedapi-2.1.14/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: loqedAPI
+Version: 2.1.14
+Summary: Python package to use the Loqed Smart Door Lock APIs in a local network. To be used by Home Assistant.
+Author-email: Casper Polhout <cpolhout@gmail.com>, Mike Woudenberg <mwoudenberg@xebia.com>
+License: BSD 2-Clause License
+        
+        Copyright (c) 2017, pyexample
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        * Redistributions of source code must retain the above copyright notice, this
+          list of conditions and the following disclaimer.
+        
+        * Redistributions in binary form must reproduce the above copyright notice,
+          this list of conditions and the following disclaimer in the documentation
+          and/or other materials provided with the distribution.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://github.com/cpolhout/loqedAPI
+Project-URL: Bug Tracker, https://github.com/cpolhout/loqedAPI/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp<3.14,>=3.8
+Requires-Dist: async-timeout
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: aioresponses; extra == "dev"
+Dynamic: license-file
+
+# 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](https://support.loqed.com/en/articles/6127856-loqed-local-bridge-api-integration) and exposes convenient helpers to read lock state, send lock/unlock commands, and manage webhooks.
+
+## Quick start
+
+1. Install the package (recommended: in a virtualenv):
+
+Using [`uv`](https://docs.astral.sh/uv/) (recommended):
+
+```bash
+uv venv
+uv pip install -e .
+```
+
+Using `pip`:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e .
+```
+
+2. Install dev/test dependencies (optional):
+
+```bash
+uv pip install -e ".[dev]"
+```
+
+or with `pip`:
+
+```bash
+pip install -e ".[dev]"
+```
+
+> Note: quote `.[dev]` (as above) — in zsh, an unquoted `.[dev]` is interpreted as a
+> glob pattern and fails with `no matches found: .[dev]`.
+
+3. Use the client (async):
+
+```python
+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 `aiohttp` for HTTP calls.
+- `APIClient` accepts `base_url` and an optional `token` (for authorization) or you can provide your own `aiohttp.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):
+
+```bash
+uv run --extra dev pytest --cov=src/loqedAPI --cov-report=term-missing
+```
+
+With `pip`/a manually activated venv:
+
+```bash
+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 via `setuptools-scm`).
+- Dev/test dependencies are available under the `dev` extra: `uv pip install -e ".[dev]"`
+  or `pip 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:
+
+1. Fork the repo, create a branch, and make your changes.
+2. Add or update tests for new behavior.
+3. Run the test suite and ensure all tests pass.
+4. 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:
+
+1. Draft a [GitHub Release](https://github.com/cpolhout/loqedAPI/releases) with a
+   tag in the form `vX.Y.Z` (e.g. `v2.1.12`).
+2. 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.
+3. CI runs the test suite, builds the sdist/wheel, and publishes to PyPI using
+   [PyPI Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (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.

loqedapi-2.1.14/README.md

@@ -0,0 +1,122 @@
+# 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](https://support.loqed.com/en/articles/6127856-loqed-local-bridge-api-integration) and exposes convenient helpers to read lock state, send lock/unlock commands, and manage webhooks.
+
+## Quick start
+
+1. Install the package (recommended: in a virtualenv):
+
+Using [`uv`](https://docs.astral.sh/uv/) (recommended):
+
+```bash
+uv venv
+uv pip install -e .
+```
+
+Using `pip`:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e .
+```
+
+2. Install dev/test dependencies (optional):
+
+```bash
+uv pip install -e ".[dev]"
+```
+
+or with `pip`:
+
+```bash
+pip install -e ".[dev]"
+```
+
+> Note: quote `.[dev]` (as above) — in zsh, an unquoted `.[dev]` is interpreted as a
+> glob pattern and fails with `no matches found: .[dev]`.
+
+3. Use the client (async):
+
+```python
+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 `aiohttp` for HTTP calls.
+- `APIClient` accepts `base_url` and an optional `token` (for authorization) or you can provide your own `aiohttp.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):
+
+```bash
+uv run --extra dev pytest --cov=src/loqedAPI --cov-report=term-missing
+```
+
+With `pip`/a manually activated venv:
+
+```bash
+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 via `setuptools-scm`).
+- Dev/test dependencies are available under the `dev` extra: `uv pip install -e ".[dev]"`
+  or `pip 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:
+
+1. Fork the repo, create a branch, and make your changes.
+2. Add or update tests for new behavior.
+3. Run the test suite and ensure all tests pass.
+4. 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:
+
+1. Draft a [GitHub Release](https://github.com/cpolhout/loqedAPI/releases) with a
+   tag in the form `vX.Y.Z` (e.g. `v2.1.12`).
+2. 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.
+3. CI runs the test suite, builds the sdist/wheel, and publishes to PyPI using
+   [PyPI Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (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.

loqedapi-2.1.14/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = pyexample
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

loqedapi-2.1.14/docs/conf.py

@@ -0,0 +1,165 @@
+# -*- coding: utf-8 -*-
+#
+# pyexample documentation build configuration file, created by
+# sphinx-quickstart on Fri Feb 23 23:07:43 2018.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+sys.path.append('../pyexample')
+
+class Mock(MagicMock):
+    @classmethod
+    def __getattr__(cls, name):
+            return MagicMock()
+
+MOCK_MODULES = ['numpy', 'mpi4py']
+sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'pyexample'
+copyright = u'2018, Stephen Hudson'
+author = u'Stephen Hudson'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'0.1.0'
+# The full version, including alpha/beta/rc tags.
+release = u'0.1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pyexampledoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'pyexample.tex', u'pyexample Documentation',
+     u'Stephen Hudson', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'pyexample', u'pyexample Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'pyexample', u'pyexample Documentation',
+     author, 'pyexample', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

loqedapi-2.1.14/docs/index.rst

@@ -0,0 +1,23 @@
+.. pyexample documentation master file, created by
+   sphinx-quickstart on Fri Feb 23 23:07:43 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pyexample's documentation!
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   
+   readme
+   mpi4py_module
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

loqedapi-2.1.14/docs/mpi4py_module.rst

@@ -0,0 +1,5 @@
+mpi4py test Module
+==================
+.. automodule:: module_mpi4py_1
+  :members:
+

loqedapi-2.1.14/docs/readme.rst

@@ -0,0 +1 @@
+.. include:: ../README.rst