uiprotect 0.3.3__tar.gz → 0.3.5__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of uiprotect might be problematic. Click here for more details.
- {uiprotect-0.3.3 → uiprotect-0.3.5}/PKG-INFO +4 -4
- {uiprotect-0.3.3 → uiprotect-0.3.5}/README.md +3 -3
- {uiprotect-0.3.3 → uiprotect-0.3.5}/pyproject.toml +5 -1
- {uiprotect-0.3.3 → uiprotect-0.3.5}/LICENSE +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/__init__.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/__main__.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/api.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/__init__.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/backup.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/base.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/cameras.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/chimes.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/doorlocks.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/events.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/lights.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/liveviews.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/nvr.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/sensors.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/cli/viewers.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/data/__init__.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/data/base.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/data/bootstrap.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/data/convert.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/data/devices.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/data/nvr.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/data/types.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/data/user.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/data/websocket.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/exceptions.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/py.typed +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/release_cache.json +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/stream.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/test_util/__init__.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/test_util/anonymize.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/utils.py +0 -0
- {uiprotect-0.3.3 → uiprotect-0.3.5}/src/uiprotect/websocket.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: uiprotect
|
|
3
|
-
Version: 0.3.
|
|
3
|
+
Version: 0.3.5
|
|
4
4
|
Summary: Python API for Unifi Protect (Unofficial)
|
|
5
5
|
Home-page: https://github.com/uilibs/uiprotect
|
|
6
6
|
License: MIT
|
|
@@ -140,7 +140,7 @@ If you want to install `uiprotect` natively, the below are the requirements:
|
|
|
140
140
|
- 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).
|
|
141
141
|
- [Python](https://www.python.org/) 3.10+
|
|
142
142
|
- POSIX compatible system
|
|
143
|
-
- Library is only
|
|
143
|
+
- Library is only tested 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.
|
|
144
144
|
- [ffmpeg](https://ffmpeg.org/)
|
|
145
145
|
- ffmpeg is primarily only for streaming audio to Protect cameras, this can be considered a soft requirement
|
|
146
146
|
|
|
@@ -194,14 +194,14 @@ Some notes about the Docker version since it is running inside of a container:
|
|
|
194
194
|
### CLI
|
|
195
195
|
|
|
196
196
|
!!! warning "About Ubiquiti SSO accounts"
|
|
197
|
-
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
|
|
197
|
+
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 console or to be used over the public Internet as both pose a security risk.
|
|
198
198
|
|
|
199
199
|
```bash
|
|
200
200
|
export UFP_USERNAME=YOUR_USERNAME_HERE
|
|
201
201
|
export UFP_PASSWORD=YOUR_PASSWORD_HERE
|
|
202
202
|
export UFP_ADDRESS=YOUR_IP_ADDRESS
|
|
203
203
|
export UFP_PORT=443
|
|
204
|
-
# change to false if you do not have a valid HTTPS
|
|
204
|
+
# change to false if you do not have a valid HTTPS certificate for your instance
|
|
205
205
|
export UFP_SSL_VERIFY=True
|
|
206
206
|
|
|
207
207
|
uiprotect --help
|
|
@@ -100,7 +100,7 @@ If you want to install `uiprotect` natively, the below are the requirements:
|
|
|
100
100
|
- 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).
|
|
101
101
|
- [Python](https://www.python.org/) 3.10+
|
|
102
102
|
- POSIX compatible system
|
|
103
|
-
- Library is only
|
|
103
|
+
- Library is only tested 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.
|
|
104
104
|
- [ffmpeg](https://ffmpeg.org/)
|
|
105
105
|
- ffmpeg is primarily only for streaming audio to Protect cameras, this can be considered a soft requirement
|
|
106
106
|
|
|
@@ -154,14 +154,14 @@ Some notes about the Docker version since it is running inside of a container:
|
|
|
154
154
|
### CLI
|
|
155
155
|
|
|
156
156
|
!!! warning "About Ubiquiti SSO accounts"
|
|
157
|
-
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
|
|
157
|
+
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 console or to be used over the public Internet as both pose a security risk.
|
|
158
158
|
|
|
159
159
|
```bash
|
|
160
160
|
export UFP_USERNAME=YOUR_USERNAME_HERE
|
|
161
161
|
export UFP_PASSWORD=YOUR_PASSWORD_HERE
|
|
162
162
|
export UFP_ADDRESS=YOUR_IP_ADDRESS
|
|
163
163
|
export UFP_PORT=443
|
|
164
|
-
# change to false if you do not have a valid HTTPS
|
|
164
|
+
# change to false if you do not have a valid HTTPS certificate for your instance
|
|
165
165
|
export UFP_SSL_VERIFY=True
|
|
166
166
|
|
|
167
167
|
uiprotect --help
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[tool.poetry]
|
|
2
2
|
name = "uiprotect"
|
|
3
|
-
version = "0.3.
|
|
3
|
+
version = "0.3.5"
|
|
4
4
|
description = "Python API for Unifi Protect (Unofficial)"
|
|
5
5
|
authors = ["UI Protect Maintainers <ui@koston.org>"]
|
|
6
6
|
license = "MIT"
|
|
@@ -68,6 +68,10 @@ myst-parser = { version = ">=0.16", python = ">=3.11"}
|
|
|
68
68
|
sphinx = { version = ">=4.0", python = ">=3.11"}
|
|
69
69
|
furo = { version = ">=2023.5.20", python = ">=3.11"}
|
|
70
70
|
sphinx-autobuild = { version = ">=2024.0.0", python = ">=3.11"}
|
|
71
|
+
mike = "^2.1.1"
|
|
72
|
+
mkdocs-material = "^9.5.26"
|
|
73
|
+
mkdocs-material-extensions = "^1.3.1"
|
|
74
|
+
pymdown-extensions = "^10.8.1"
|
|
71
75
|
|
|
72
76
|
[tool.semantic_release]
|
|
73
77
|
version_toml = ["pyproject.toml:tool.poetry.version"]
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|