What
pyzmNg is a rewrite of pyzm.
It's a pythonic wrapper that integrates with ZM and also operates as a standalone ML library. Key features:
- ZM API
- ZM EventServerNg
- ZM Logger
- ZM Memory
- Machine Learning Modules (with our without ZM)
Installation
See the installation guide on ReadTheDocs.
Documentation & Examples
Latest documentation is available here. The documentation includes a full example.
Features
- API auth using tokens or legacy (manages refresh logins automatically)
- Monitors
- Events with filters
- States
- Configs
- EventNotification callbacks
- Mapped Memory access
- Direct access to ML algorithms
- Remote ML detection server (
pyzm.serve) — run models on a GPU box, detect from anywhere - Amazon Rekognition support for object detection
Training UI
pyzm includes a Streamlit-based UI for fine-tuning YOLO models on your own data:
/opt/zoneminder/venv/bin/python -m streamlit run pyzm/train/app.py -- --base-path /var/lib/zmeventnotification/models
The --base-path flag points to your ZoneMinder models directory (defaults to /var/lib/zmeventnotification/models). Projects are stored in ~/.pyzm/training/.
Testing
pyzm has three test tiers:
Unit / integration tests (no hardware required):
pip install pytest
python -m pytest tests/ -m "not e2e and not zm_e2e" -v
ML end-to-end tests (require real ML models on disk):
# Requires models in /var/lib/zmeventnotification/models/
# and the test image at tests/test_ml_e2e/bird.jpg (included in repo)
python -m pytest tests/test_ml_e2e/ -v
# Skip the slower remote-serve tests:
python -m pytest tests/test_ml_e2e/ -v -m "not serve"
ZoneMinder end-to-end tests (require a live ZM server):
One-time setup:
sudo /opt/zoneminder/venv/bin/pip install pytest
cp tests/.env.zm_e2e.sample .env.zm_e2e # edit with your ZM server details
# Readonly tests (auth, monitors, events, zones, frames, detection):
sudo -u www-data /opt/zoneminder/venv/bin/python -m pytest tests/test_zm_e2e/ -v -p no:cacheprovider
# Include write tests (event notes, stop/start/restart, DB tagging):
sudo -u www-data ZM_E2E_WRITE=1 /opt/zoneminder/venv/bin/python -m pytest tests/test_zm_e2e/ -v -p no:cacheprovider
ZM E2E tests auto-skip when .env.zm_e2e is missing, so pytest tests/ is always safe.
Developer Notes (for myself)
To make a release:
./scripts/make_release.sh
To skip PyPI upload (e.g. package already published):
./scripts/make_release.sh --skip-pypi
To test docs:
cd docs/
make html && python -m http.server -d _build/html
To test a CHANGELOG:
# __version__ in pyzm/__init__.py should be updated
# replace v2.0.3 with whatever future version
GITHUB_TOKEN=$(gh auth token) git-cliff --tag "v2.0.3"
Limitations
- Requires Python 3.10+
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyzm-2.5.1.tar.gz.
File metadata
- Download URL: pyzm-2.5.1.tar.gz
- Upload date:
- Size: 505.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
68c64ab69a4ff7051af0678f761827e441cd5d208ff48b81481f54c2f3b5f24d
|
|
| MD5 |
921a534fd6999762406432f0d31d218a
|
|
| BLAKE2b-256 |
46a850b30db44cfd7865ef8869538098a03e38d1cd5df15e3adf17af5af0e2e2
|
File details
Details for the file pyzm-2.5.1-py3-none-any.whl.
File metadata
- Download URL: pyzm-2.5.1-py3-none-any.whl
- Upload date:
- Size: 415.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
666aebbfc997445c3f5dc9f2d6fd246da650cc6d3129e2fab64d3e48c600ac62
|
|
| MD5 |
18397418965daf80950934a2e700a444
|
|
| BLAKE2b-256 |
f749e2af752ee7df9f8f6b34844f7df265c65e70de75df819930ffeb72052aef
|
