uiprotect 0.1.0__tar.gz

uiprotect-0.1.0/LICENSE

@@ -0,0 +1,23 @@
+
+MIT License
+
+Copyright (c) 2024 UI Protect Maintainers
+Copyright (c) 2020 Bjarne Riis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

uiprotect-0.1.0/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.1
+Name: uiprotect
+Version: 0.1.0
+Summary: Python API for Unifi Protect (Unofficial)
+Home-page: https://github.com/uilibs/uiprotect
+License: MIT
+Author: UI Protect Maintainers
+Author-email: ui@koston.org
+Requires-Python: >=3.10
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Requires-Dist: aiofiles (>=23)
+Requires-Dist: aiohttp (>=3.9.0)
+Requires-Dist: aioshutil (>=1.3)
+Requires-Dist: async-timeout (>=3.0.1)
+Requires-Dist: dateparser (>=1.1.0)
+Requires-Dist: orjson (>=3.9)
+Requires-Dist: packaging (>=23)
+Requires-Dist: pillow (>=10)
+Requires-Dist: platformdirs (>=4)
+Requires-Dist: pydantic (!=1.9.1)
+Requires-Dist: pyjwt (>=2.6)
+Requires-Dist: rich (>=10)
+Requires-Dist: typer[all] (>0.6)
+Requires-Dist: yarl (>=1.9)
+Project-URL: Bug Tracker, https://github.com/uilibs/uiprotect/issues
+Project-URL: Changelog, https://github.com/uilibs/uiprotect/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://uiprotect.readthedocs.io
+Project-URL: Repository, https://github.com/uilibs/uiprotect
+Description-Content-Type: text/markdown
+
+# Unofficial UniFi Protect Python API and CLI
+
+<p align="center">
+  <a href="https://github.com/uilibs/uiprotect/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/uilibs/uiprotect/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://uiprotect.readthedocs.io">
+    <img src="https://img.shields.io/readthedocs/uiprotect.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
+  </a>
+  <a href="https://codecov.io/gh/uilibs/uiprotect">
+    <img src="https://img.shields.io/codecov/c/github/uilibs/uiprotect.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+</p>
+<p align="center">
+  <a href="https://python-poetry.org/">
+    <img src="https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json" alt="Poetry">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+  <a href="https://github.com/pre-commit/pre-commit">
+    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/uiprotect/">
+    <img src="https://img.shields.io/pypi/v/uiprotect.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/uiprotect.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/uiprotect.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Documentation**: <a href="https://uiprotect.readthedocs.io" target="_blank">https://uiprotect.readthedocs.io </a>
+
+**Source Code**: <a href="https://github.com/uilibs/uiprotect" target="_blank">https://github.com/uilibs/uiprotect </a>
+
+---
+
+Python API for Unifi Protect (Unofficial)
+
+## Installation
+
+Install this via pip (or your favorite package manager):
+
+`pip install uiprotect`
+
+## Credits
+
+- Bjarne Riis ([@briis](https://github.com/briis/)) for the original pyunifiprotect package
+- Christopher Bailey ([@AngellusMortis](https://github.com/AngellusMortis/)) for the maintaining the pyunifiprotect package
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-enable -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-end -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+`uiprotect` is an unofficial API for UniFi Protect. There is no affiliation with Ubiquiti.
+
+This module communicates with UniFi Protect surveillance software installed on a UniFi OS Console such as a Ubiquiti CloudKey+ or UniFi Dream Machine Pro.
+
+The API is not documented by Ubiquiti, so there might be misses and/or frequent changes in this module, as Ubiquiti evolves the software.
+
+The module is primarily written for the purpose of being used in Home Assistant core [integration for UniFi Protect](https://www.home-assistant.io/integrations/unifiprotect) but might be used for other purposes also.
+
+## Smart Detections now Require Remote Access to enable
+
+Smart Detections (person, vehicle, animal, face), a feature that previously could be used with local only console, [now requires you to enable remote access to enable](https://community.ui.com/questions/Cannot-enable-Smart-Detections/e3d50641-5c00-4607-9723-453cda557e35#answer/1d146426-89aa-4022-a0ae-fd5000846028).
+
+Enabling Remote Access may grant other users access to your console [due to the fact Ubiquiti can reconfigure access controls at any time](https://community.ui.com/questions/Bug-Fix-Cloud-Access-Misconfiguration/fe8d4479-e187-4471-bf95-b2799183ceb7).
+
+If you are not okay with the feature being locked behind Remote Access access, [let Ubiquiti know](https://community.ui.com/questions/Cannot-enable-Smart-Detections/e3d50641-5c00-4607-9723-453cda557e35).
+
+## Documentation
+
+[Full documentation for the project](https://uilibs.github.io/uiprotect/).
+
+## Requirements
+
+If you want to install `uiprotect` natively, the below are the requirements:
+
+- [UniFi Protect](https://ui.com/camera-security) version 1.20+
+  - Latest version of library is generally only tested against the two latest minor version. This is either two latest stable versions (such as 1.21.x and 2.0.x) or the latest EA version and stable version (such as 2.2.x EA and 2.1.x).
+- [Python](https://www.python.org/) 3.9+
+- POSIX compatible system
+  - Library is only test on Linux, specifically the latest Debian version available for the official Python Docker images, but there is no reason the library should not work on any Linux distro or MacOS.
+- [ffmpeg](https://ffmpeg.org/)
+  - ffmpeg is primarily only for streaming audio to Protect cameras, this can be considered a soft requirement
+
+Alternatively you can use the [provided Docker container](#using-docker-container), in which case the only requirement is [Docker](https://docs.docker.com/desktop/) or another OCI compatible orchestrator (such as Kubernetes or podman).
+
+Windows is **not supported**. If you need to use `uiprotect` on Windows, use Docker Desktop and the provided docker container or [WSL](https://docs.microsoft.com/en-us/windows/wsl/install).
+
+## Install
+
+### From PyPi
+
+`uiprotect` is available on PyPi:
+
+```bash
+pip install uiprotect
+```
+
+### From Github
+
+```bash
+pip install git+https://github.com/uilibs/uiprotect.git#egg=uiprotect
+```
+
+### Using Docker Container
+
+A Docker container is also provided so you do not need to install/manage Python as well. You can add the following to your `.bashrc` or similar.
+
+```bash
+function unifi-protect() {
+    docker run --rm -it \
+      -e UFP_USERNAME=YOUR_USERNAME_HERE \
+      -e UFP_PASSWORD=YOUR_PASSWORD_HERE \
+      -e UFP_ADDRESS=YOUR_IP_ADDRESS \
+      -e UFP_PORT=443 \
+      -e UFP_SSL_VERIFY=True \
+      -e TZ=America/New_York \
+      -v $PWD:/data ghcr.io/uilibs/uiprotect:latest "$@"
+}
+```
+
+Some notes about the Docker version since it is running inside of a container:
+
+- You can update at any time using the command `docker pull ghcr.io/uilibs/uiprotect:latest`
+- Your local current working directory (`$PWD`) will automatically be mounted to `/data` inside of the container. For commands that output files, this is the _only_ path you can write to and have the file persist.
+- The container supports `linux/amd64` and `linux/arm64` natively. This means it will also work well on MacOS or Windows using Docker Desktop.
+- `TZ` should be the [Olson timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the timezone your UniFi Protect instance is in.
+- For more details on `TZ` and other environment variables, check the [command line docs](https://uilibs.github.io/uiprotect/latest/cli/)
+
+## Quickstart
+
+### CLI
+
+!!! warning "About Ubiquiti SSO accounts"
+Ubiquiti SSO accounts are not supported and actively discouraged from being used. There is no option to use MFA. You are expected to use local access user. `uiprotect` is not designed to allow you to use your owner account to access the your console or to be used over the public Internet as both pose a security risk.
+
+```bash
+export UFP_USERNAME=YOUR_USERNAME_HERE
+export UFP_PASSWORD=YOUR_PASSWORD_HERE
+export UFP_ADDRESS=YOUR_IP_ADDRESS
+export UFP_PORT=443
+# change to false if you do not have a valid HTTPS Certificate for your instance
+export UFP_SSL_VERIFY=True
+
+unifi-protect --help
+unifi-protect nvr
+```
+
+### Python
+
+UniFi Protect itself is 100% async, so as such this library is primarily designed to be used in an async context.
+
+The main interface for the library is the `uiprotect.ProtectApiClient`:
+
+```python
+from uiprotect import ProtectApiClient
+
+protect = ProtectApiClient(host, port, username, password, verify_ssl=True)
+
+await protect.update() # this will initialize the protect .bootstrap and open a Websocket connection for updates
+
+# get names of your cameras
+for camera in protect.bootstrap.cameras.values():
+    print(camera.name)
+
+# subscribe to Websocket for updates to UFP
+def callback(msg: WSSubscriptionMessage):
+    # do stuff
+
+unsub = protect.subscribe_websocket(callback)
+
+# remove subscription
+unsub()
+
+```
+
+## TODO / Planned / Not Implemented
+
+Generally any feature missing from the library is planned to be done eventually / nice to have with the following exceptions
+
+### UniFi OS Features
+
+Anything that is strictly a UniFi OS feature. If it ever done, it will be in a separate library that interacts with this one. Examples include:
+
+- Managing RAID and disks
+- Creating and managing users
+
+Examples include:
+
+- Stream sharing
+- Smart Detections, including person, vehicle, animals license plate and faces
+

uiprotect-0.1.0/README.md

@@ -0,0 +1,205 @@
+# Unofficial UniFi Protect Python API and CLI
+
+<p align="center">
+  <a href="https://github.com/uilibs/uiprotect/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/uilibs/uiprotect/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://uiprotect.readthedocs.io">
+    <img src="https://img.shields.io/readthedocs/uiprotect.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
+  </a>
+  <a href="https://codecov.io/gh/uilibs/uiprotect">
+    <img src="https://img.shields.io/codecov/c/github/uilibs/uiprotect.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+</p>
+<p align="center">
+  <a href="https://python-poetry.org/">
+    <img src="https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json" alt="Poetry">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+  <a href="https://github.com/pre-commit/pre-commit">
+    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/uiprotect/">
+    <img src="https://img.shields.io/pypi/v/uiprotect.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/uiprotect.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/uiprotect.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Documentation**: <a href="https://uiprotect.readthedocs.io" target="_blank">https://uiprotect.readthedocs.io </a>
+
+**Source Code**: <a href="https://github.com/uilibs/uiprotect" target="_blank">https://github.com/uilibs/uiprotect </a>
+
+---
+
+Python API for Unifi Protect (Unofficial)
+
+## Installation
+
+Install this via pip (or your favorite package manager):
+
+`pip install uiprotect`
+
+## Credits
+
+- Bjarne Riis ([@briis](https://github.com/briis/)) for the original pyunifiprotect package
+- Christopher Bailey ([@AngellusMortis](https://github.com/AngellusMortis/)) for the maintaining the pyunifiprotect package
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-enable -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-end -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+`uiprotect` is an unofficial API for UniFi Protect. There is no affiliation with Ubiquiti.
+
+This module communicates with UniFi Protect surveillance software installed on a UniFi OS Console such as a Ubiquiti CloudKey+ or UniFi Dream Machine Pro.
+
+The API is not documented by Ubiquiti, so there might be misses and/or frequent changes in this module, as Ubiquiti evolves the software.
+
+The module is primarily written for the purpose of being used in Home Assistant core [integration for UniFi Protect](https://www.home-assistant.io/integrations/unifiprotect) but might be used for other purposes also.
+
+## Smart Detections now Require Remote Access to enable
+
+Smart Detections (person, vehicle, animal, face), a feature that previously could be used with local only console, [now requires you to enable remote access to enable](https://community.ui.com/questions/Cannot-enable-Smart-Detections/e3d50641-5c00-4607-9723-453cda557e35#answer/1d146426-89aa-4022-a0ae-fd5000846028).
+
+Enabling Remote Access may grant other users access to your console [due to the fact Ubiquiti can reconfigure access controls at any time](https://community.ui.com/questions/Bug-Fix-Cloud-Access-Misconfiguration/fe8d4479-e187-4471-bf95-b2799183ceb7).
+
+If you are not okay with the feature being locked behind Remote Access access, [let Ubiquiti know](https://community.ui.com/questions/Cannot-enable-Smart-Detections/e3d50641-5c00-4607-9723-453cda557e35).
+
+## Documentation
+
+[Full documentation for the project](https://uilibs.github.io/uiprotect/).
+
+## Requirements
+
+If you want to install `uiprotect` natively, the below are the requirements:
+
+- [UniFi Protect](https://ui.com/camera-security) version 1.20+
+  - Latest version of library is generally only tested against the two latest minor version. This is either two latest stable versions (such as 1.21.x and 2.0.x) or the latest EA version and stable version (such as 2.2.x EA and 2.1.x).
+- [Python](https://www.python.org/) 3.9+
+- POSIX compatible system
+  - Library is only test on Linux, specifically the latest Debian version available for the official Python Docker images, but there is no reason the library should not work on any Linux distro or MacOS.
+- [ffmpeg](https://ffmpeg.org/)
+  - ffmpeg is primarily only for streaming audio to Protect cameras, this can be considered a soft requirement
+
+Alternatively you can use the [provided Docker container](#using-docker-container), in which case the only requirement is [Docker](https://docs.docker.com/desktop/) or another OCI compatible orchestrator (such as Kubernetes or podman).
+
+Windows is **not supported**. If you need to use `uiprotect` on Windows, use Docker Desktop and the provided docker container or [WSL](https://docs.microsoft.com/en-us/windows/wsl/install).
+
+## Install
+
+### From PyPi
+
+`uiprotect` is available on PyPi:
+
+```bash
+pip install uiprotect
+```
+
+### From Github
+
+```bash
+pip install git+https://github.com/uilibs/uiprotect.git#egg=uiprotect
+```
+
+### Using Docker Container
+
+A Docker container is also provided so you do not need to install/manage Python as well. You can add the following to your `.bashrc` or similar.
+
+```bash
+function unifi-protect() {
+    docker run --rm -it \
+      -e UFP_USERNAME=YOUR_USERNAME_HERE \
+      -e UFP_PASSWORD=YOUR_PASSWORD_HERE \
+      -e UFP_ADDRESS=YOUR_IP_ADDRESS \
+      -e UFP_PORT=443 \
+      -e UFP_SSL_VERIFY=True \
+      -e TZ=America/New_York \
+      -v $PWD:/data ghcr.io/uilibs/uiprotect:latest "$@"
+}
+```
+
+Some notes about the Docker version since it is running inside of a container:
+
+- You can update at any time using the command `docker pull ghcr.io/uilibs/uiprotect:latest`
+- Your local current working directory (`$PWD`) will automatically be mounted to `/data` inside of the container. For commands that output files, this is the _only_ path you can write to and have the file persist.
+- The container supports `linux/amd64` and `linux/arm64` natively. This means it will also work well on MacOS or Windows using Docker Desktop.
+- `TZ` should be the [Olson timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the timezone your UniFi Protect instance is in.
+- For more details on `TZ` and other environment variables, check the [command line docs](https://uilibs.github.io/uiprotect/latest/cli/)
+
+## Quickstart
+
+### CLI
+
+!!! warning "About Ubiquiti SSO accounts"
+Ubiquiti SSO accounts are not supported and actively discouraged from being used. There is no option to use MFA. You are expected to use local access user. `uiprotect` is not designed to allow you to use your owner account to access the your console or to be used over the public Internet as both pose a security risk.
+
+```bash
+export UFP_USERNAME=YOUR_USERNAME_HERE
+export UFP_PASSWORD=YOUR_PASSWORD_HERE
+export UFP_ADDRESS=YOUR_IP_ADDRESS
+export UFP_PORT=443
+# change to false if you do not have a valid HTTPS Certificate for your instance
+export UFP_SSL_VERIFY=True
+
+unifi-protect --help
+unifi-protect nvr
+```
+
+### Python
+
+UniFi Protect itself is 100% async, so as such this library is primarily designed to be used in an async context.
+
+The main interface for the library is the `uiprotect.ProtectApiClient`:
+
+```python
+from uiprotect import ProtectApiClient
+
+protect = ProtectApiClient(host, port, username, password, verify_ssl=True)
+
+await protect.update() # this will initialize the protect .bootstrap and open a Websocket connection for updates
+
+# get names of your cameras
+for camera in protect.bootstrap.cameras.values():
+    print(camera.name)
+
+# subscribe to Websocket for updates to UFP
+def callback(msg: WSSubscriptionMessage):
+    # do stuff
+
+unsub = protect.subscribe_websocket(callback)
+
+# remove subscription
+unsub()
+
+```
+
+## TODO / Planned / Not Implemented
+
+Generally any feature missing from the library is planned to be done eventually / nice to have with the following exceptions
+
+### UniFi OS Features
+
+Anything that is strictly a UniFi OS feature. If it ever done, it will be in a separate library that interacts with this one. Examples include:
+
+- Managing RAID and disks
+- Creating and managing users
+
+Examples include:
+
+- Stream sharing
+- Smart Detections, including person, vehicle, animals license plate and faces

uiprotect-0.1.0/pyproject.toml

@@ -0,0 +1,192 @@
+[tool.poetry]
+name = "uiprotect"
+version = "0.1.0"
+description = "Python API for Unifi Protect (Unofficial)"
+authors = ["UI Protect Maintainers <ui@koston.org>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/uilibs/uiprotect"
+documentation = "https://uiprotect.readthedocs.io"
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries",
+]
+packages = [
+    { include = "uiprotect", from = "src" },
+]
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/uilibs/uiprotect/issues"
+"Changelog" = "https://github.com/uilibs/uiprotect/blob/main/CHANGELOG.md"
+
+[tool.poetry.scripts]
+uiprotect = "uiprotect.cli:app"
+
+[tool.poetry.dependencies]
+python = ">=3.10"
+rich = ">=10"
+typer = {version = ">0.6", extras = ["all"]}
+async-timeout = ">=3.0.1"
+aiofiles = ">=23"
+aiohttp = ">=3.9.0"
+aioshutil = ">=1.3"
+dateparser = ">=1.1.0"
+orjson = ">=3.9"
+packaging = ">=23"
+pillow = ">=10"
+platformdirs = ">=4"
+pydantic = "!=1.9.1"
+pyjwt = ">=2.6"
+yarl = ">=1.9"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.0"
+pytest-cov = "^3.0"
+aiosqlite = ">=0.20.0"
+asttokens = "^2.4.1"
+pytest-asyncio = "^0.23.7"
+pytest-benchmark = "^4.0.0"
+pytest-sugar = "^1.0.0"
+pytest-timeout = "^2.3.1"
+pytest-xdist = "^3.6.1"
+types-aiofiles = "^23.2.0.20240403"
+types-dateparser = "^1.2.0.20240420"
+mypy = "^1.10.0"
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+myst-parser = { version = ">=0.16", python = ">=3.11"}
+sphinx = { version = ">=4.0", python = ">=3.11"}
+furo = { version = ">=2023.5.20", python = ">=3.11"}
+sphinx-autobuild = { version = ">=2024.0.0", python = ">=3.11"}
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:tool.poetry.version"]
+version_variables = [
+    "src/uiprotect/__init__.py:__version__",
+    "docs/conf.py:release",
+]
+build_command = "pip install poetry && poetry build"
+
+[tool.semantic_release.changelog]
+exclude_commit_patterns = [
+    "chore*",
+    "ci*",
+]
+
+[tool.semantic_release.changelog.environment]
+keep_trailing_newline = true
+
+[tool.semantic_release.branches.main]
+match = "main"
+
+[tool.semantic_release.branches.noop]
+match = "(?!main$)"
+prerelease = true
+
+[tool.pytest.ini_options]
+addopts = "-v -Wdefault --cov=uiprotect --cov-report=term-missing:skip-covered -n=auto"
+pythonpath = ["src"]
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "@overload",
+    "if TYPE_CHECKING",
+    "raise NotImplementedError",
+    'if __name__ == "__main__":',
+]
+
+[tool.ruff]
+target-version = "py38"
+line-length = 88
+
+[tool.ruff.lint]
+ignore = [
+    "S101", # use of assert
+    "D203", # 1 blank line required before class docstring
+    "D212", # Multi-line docstring summary should start at the first line
+    "D100", # Missing docstring in public module
+    "D101", # Missing docstring in public module
+    "D102", # Missing docstring in public method
+    "D103", # Missing docstring in public module
+    "D104", # Missing docstring in public package
+    "D105", # Missing docstring in magic method
+    "D107", # Missing docstring in `__init__`
+    "D400", # First line should end with a period
+    "D401", # First line of docstring should be in imperative mood
+    "D205", # 1 blank line required between summary line and description
+    "D415", # First line should end with a period, question mark, or exclamation point
+    "D417", # Missing argument descriptions in the docstring
+    "E501", # Line too long
+    "RUF012", # Mutable class attributes should be annotated with `typing.ClassVar`
+    "B008", # Do not perform function call
+    "S110", # `try`-`except`-`pass` detected, consider logging the exception
+    "D106", # Missing docstring in public nested class
+    "UP007", # typer needs Optional syntax
+]
+select = [
+    "B",   # flake8-bugbear
+    "D",   # flake8-docstrings
+    "C4",  # flake8-comprehensions
+    "S",   # flake8-bandit
+    "F",   # pyflake
+    "E",   # pycodestyle
+    "W",   # pycodestyle
+    "UP",  # pyupgrade
+    "I",   # isort
+    "RUF", # ruff specific
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*" = [
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "S101",
+]
+"setup.py" = ["D100"]
+"conftest.py" = ["D100"]
+"docs/conf.py" = ["D100"]
+
+[tool.ruff.isort]
+known-first-party = ["uiprotect", "tests"]
+
+[tool.mypy]
+disable_error_code = "import-untyped,unused-ignore"
+check_untyped_defs = true
+ignore_missing_imports = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+mypy_path = "src/"
+no_implicit_optional = true
+show_error_codes = true
+warn_unreachable = true
+warn_unused_ignores = true
+exclude = [
+    'docs/.*',
+    'setup.py',
+]
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+allow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = "docs.*"
+ignore_errors = true
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

uiprotect-0.1.0/src/uiprotect/__init__.py

@@ -0,0 +1,13 @@
+"""Unofficial UniFi Protect Python API and Command Line Interface."""
+
+from __future__ import annotations
+
+from uiprotect.api import ProtectApiClient
+from uiprotect.exceptions import Invalid, NotAuthorized, NvrError
+
+__all__ = [
+    "Invalid",
+    "NotAuthorized",
+    "NvrError",
+    "ProtectApiClient",
+]