onvif-python 0.1.0__tar.gz → 0.1.1__tar.gz

{onvif_python-0.1.0/onvif_python.egg-info → onvif_python-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onvif-python
-Version: 0.1.0
+Version: 0.1.1
 Summary: A comprehensive and developer-friendly Python library for working with ONVIF-compliant devices
 Author-email: Nirsimetri Technologies® <open@nirsimetri.com>
 Maintainer: Kaburagi
@@ -40,9 +40,9 @@ Dynamic: license-file
 
 [![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/nirsimetri/onvif-python?tab=MIT-1-ov-file)
 [![DeepWiki](https://img.shields.io/badge/DeepWiki-AI%20Wiki-orange)](https://deepwiki.com/nirsimetri/onvif-python)
-[![Release](https://img.shields.io/badge/Release-v0.1.0-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
+[![Release](https://img.shields.io/badge/Release-v0.1.1-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
 <br>
-[![PyPI](https://img.shields.io/badge/PyPI-0.1.0-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.1-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
 [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=PyPI%20Downloads)](https://clickpy.clickhouse.com/dashboard/onvif-python)
 
 **This project provides a comprehensive and developer-friendly Python library for working with ONVIF-compliant devices.** It is designed to be reliable, easy to integrate, and flexible enough to support a wide range of ONVIF profiles and services.  
@@ -66,6 +66,13 @@ This library simplifies that process by wrapping SOAP communication into a clean
 - **Companies** building video intelligence, analytics, or VMS platforms  
 - **Security integrators** who need reliable ONVIF interoperability across devices
 
+## Requirements
+
+- **Python**: 3.9 or higher
+- **Dependencies**:
+  - [`zeep>=4.3.0`](https://github.com/mvantellingen/python-zeep) - SOAP client for ONVIF communication
+  - [`requests>=2.32.0`](https://github.com/psf/requests) - HTTP library for network requests
+
 ## Installation
 
 From official [PyPI](https://pypi.org/project/onvif-python/):
@@ -151,6 +158,73 @@ Explore more advanced usage and service-specific operations in the [`examples/`]
 > [!IMPORTANT]
 > If you're new to ONVIF and want to learn more, we highly recommend taking the official free online course provided by ONVIF at [Introduction to ONVIF Course](https://www.onvif.org/about/introduction-to-onvif-course). Please note that we are not endorsed or sponsored by ONVIF, see [Legal Notice](#legal-notice) for details.
 
+## ONVIF CLI
+
+> [!NOTE]
+> The CLI is automatically installed when you install the `onvif-python` see [Installation](#installation). This feature has been available since onvif-python version [0.1.0](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.1)
+
+This library includes a powerful command-line interface (CLI) for interacting with ONVIF devices directly from your terminal. It supports both direct command execution and an interactive shell mode, providing a flexible and efficient way to manage and debug ONVIF devices.
+
+### Features
+
+- **Interactive Shell:** A user-friendly shell with tab completion, command history, and colorized output.
+- **Direct Command Execution:** Run ONVIF commands directly from the terminal for scripting and automation.
+- **Automatic Discovery:** Automatically detects available services on the device.
+- **Connection Management:** Supports HTTP/HTTPS, custom timeouts, and SSL verification.
+- **Data Management:** Store results from commands and use them as parameters in subsequent commands.
+- **Cross-Platform:** Works on Windows, macOS, and Linux.
+
+### Usage
+
+**1. Interactive Mode**
+
+The interactive shell is recommended for exploration and debugging. It provides an intuitive way to navigate services, call methods, and view results.
+
+To start the interactive shell, provide the connection details:
+
+```bash
+onvif --host 192.168.1.17 --port 8000 --username admin --password admin123 -i
+```
+
+If you omit the username or password, you will be prompted to enter them securely.
+
+**Interactive Shell Commands:**
+| Command | Description |
+|---|---|
+| `help` | Show help information |
+| `ls` | List available services or methods in the current context |
+| `cd <service>` | Enter a service mode (e.g., `cd devicemgmt`) |
+| `up` | Go back to the root context |
+| `pwd` | Show the current service context |
+| `desc <method>` | Show documentation for a method |
+| `store <name>` | Store the last result with a variable name |
+| `show <name>` | Display a stored variable |
+| `exit` / `quit` | Exit the shell |
+
+You can see all the commands available in the interactive shell by trying them directly.
+
+**2. Direct Command Execution**
+
+You can also execute a single ONVIF command directly. This is useful for scripting or quick checks.
+
+**Syntax:**
+```bash
+onvif <service> <method> [parameters...] -H <host> -P <port> -u <user> -p <pass>
+```
+
+**Example:**
+```bash
+# Get device capabilities
+onvif devicemgmt GetCapabilities Category=All -H 192.168.1.17 -P 8000 -u admin -p admin123
+
+# Move a PTZ camera
+onvif ptz ContinuousMove ProfileToken=Profile_1 Velocity='{"PanTilt": {"x": 0.1}}' -H 192.168.1.17 -P 8000 -u admin -p admin123
+```
+
+### CLI Parameters
+
+All `ONVIFClient` parameters (like `--timeout`, `--https`, `--cache`, etc.) are available as command-line arguments. Use `onvif --help` to see all available options.
+
 ## ONVIFClient Parameters
 
 The `ONVIFClient` class provides various configuration options to customize the connection behavior, caching strategy, security settings, and debugging capabilities. Below is a detailed description of all available parameters:
@@ -193,9 +267,9 @@ The `ONVIFClient` class provides various configuration options to customize the
 
 | Parameter | Type | Required | Default | Description |
 |-----------|------|----------|---------|-------------|
-| `apply_patch` | `bool` | ❌ No | `True` | Enable zeep patching for better `xsd:any` field parsing and automatic flattening, applied at (>= [`v0.0.4`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.4)) |
-| `capture_xml` | `bool` | ❌ No | `False` | Enable XML capture plugin for debugging SOAP requests/responses, applied at (>= [`v0.0.6`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.6)) |
-| `wsdl_dir`    | `str`  | ❌ No | `None` | Custom WSDL directory path for using external WSDL files instead of built-in ones (e.g., `/path/to/custom/wsdl`), applied at (>= [`v0.1.0`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.0)) |
+| `apply_patch` | `bool` | ❌ No | `True` | Enable zeep patching for better `xsd:any` field parsing and automatic flattening, applied at ([`>=v0.0.4`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.4)) |
+| `capture_xml` | `bool` | ❌ No | `False` | Enable XML capture plugin for debugging SOAP requests/responses, applied at ([`>=v0.0.6`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.6)) |
+| `wsdl_dir`    | `str`  | ❌ No | `None` | Custom WSDL directory path for using external WSDL files instead of built-in ones (e.g., `/path/to/custom/wsdl`), applied at ([`>=v0.1.0`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.0)) |
 
 </details>
 
@@ -428,53 +502,6 @@ else:
 - **GetCapabilities** is **mandatory** for all ONVIF-compliant devices, ensuring broader compatibility
 - **Default URLs** guarantee basic connectivity even with non-compliant devices
 
-**Get detailed service information:**
-
-If you need comprehensive service details, you can manually call `GetServices` with capabilities:
-
-```python
-device = client.devicemgmt()
-
-try:
-    # Try to get detailed service information
-    services = device.GetServices(IncludeCapability=True)
-    for service in services:
-        print(f"Service: {service.Namespace}")
-        print(f"XAddr: {service.XAddr}")
-        if hasattr(service, 'Capabilities'):
-            print(f"Capabilities: {service.Capabilities}")
-except Exception:
-    # Fallback to GetCapabilities for legacy devices
-    capabilities = device.GetCapabilities()
-    print("Capabilities:", capabilities)
-```
-
-**Access capabilities information:**
-
-When using `GetCapabilities` fallback, you can access capability information:
-
-```python
-device = client.devicemgmt()
-
-try:
-    # Get capabilities information from device
-    capabilities = device.GetCapabilities()
-    
-    # Main services (always available)
-    print("Media XAddr:", getattr(capabilities.Media, 'XAddr', 'Not available'))
-    print("PTZ XAddr:", getattr(capabilities.PTZ, 'XAddr', 'Not available'))
-    
-    # Extension services (device-dependent)
-    ext = getattr(capabilities, 'Extension', None)
-    if ext:
-        print("DeviceIO XAddr:", getattr(ext.DeviceIO, 'XAddr', 'Not available'))
-        print("Recording XAddr:", getattr(ext.Recording, 'XAddr', 'Not available'))
-        print("Search XAddr:", getattr(ext.Search, 'XAddr', 'Not available'))
-        print("Replay XAddr:", getattr(ext.Replay, 'XAddr', 'Not available'))
-except Exception as e:
-    print(f"Error getting capabilities: {e}")
-```
-
 > [!TIP]
 > The library handles service discovery automatically with intelligent fallback. You typically don't need to call discovery methods manually unless you need detailed capability information or want to refresh the service list after device configuration changes.
 
@@ -630,8 +657,8 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
 ## Future Improvements (Stay tuned and star ⭐ this repo)
 
 - [x] ~~Add debugging mode with raw xml on SOAP requests and responses.~~ ([c258162](https://github.com/nirsimetri/onvif-python/commit/c258162))
-- [x] ~~Add functionality for `ONVIFClient` to accept a custom `wsdl_dir` service.~~ ([65f2570](https://github.com/nirsimetri/onvif-python/commit/65f257092e4c9daa23dd0d00825ed38a45d23b70))
-- [ ] Add `ONVIF CLI` program to interact directly with ONVIF devices via terminal.
+- [x] ~~Add functionality for `ONVIFClient` to accept a custom `wsdl_dir` service.~~ ([65f2570](https://github.com/nirsimetri/onvif-python/commit/65f2570))
+- [x] ~~Add `ONVIF CLI` program to interact directly with ONVIF devices via terminal.~~ ([645be01](https://github.com/nirsimetri/onvif-python/commit/645be01))
 - [ ] Add asynchronous (async/await) support for non-blocking ONVIF operations and concurrent device communication.
 - [ ] Implement structured data models for ONVIF Schemas using [xsdata](https://github.com/tefra/xsdata).
 - [ ] Integrate [xmltodict](https://github.com/martinblech/xmltodict) for simplified XML parsing and conversion.

{onvif_python-0.1.0 → onvif_python-0.1.1}/README.md

@@ -2,9 +2,9 @@
 
 [![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/nirsimetri/onvif-python?tab=MIT-1-ov-file)
 [![DeepWiki](https://img.shields.io/badge/DeepWiki-AI%20Wiki-orange)](https://deepwiki.com/nirsimetri/onvif-python)
-[![Release](https://img.shields.io/badge/Release-v0.1.0-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
+[![Release](https://img.shields.io/badge/Release-v0.1.1-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
 <br>
-[![PyPI](https://img.shields.io/badge/PyPI-0.1.0-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.1-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
 [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=PyPI%20Downloads)](https://clickpy.clickhouse.com/dashboard/onvif-python)
 
 **This project provides a comprehensive and developer-friendly Python library for working with ONVIF-compliant devices.** It is designed to be reliable, easy to integrate, and flexible enough to support a wide range of ONVIF profiles and services.  
@@ -28,6 +28,13 @@ This library simplifies that process by wrapping SOAP communication into a clean
 - **Companies** building video intelligence, analytics, or VMS platforms  
 - **Security integrators** who need reliable ONVIF interoperability across devices
 
+## Requirements
+
+- **Python**: 3.9 or higher
+- **Dependencies**:
+  - [`zeep>=4.3.0`](https://github.com/mvantellingen/python-zeep) - SOAP client for ONVIF communication
+  - [`requests>=2.32.0`](https://github.com/psf/requests) - HTTP library for network requests
+
 ## Installation
 
 From official [PyPI](https://pypi.org/project/onvif-python/):
@@ -113,6 +120,73 @@ Explore more advanced usage and service-specific operations in the [`examples/`]
 > [!IMPORTANT]
 > If you're new to ONVIF and want to learn more, we highly recommend taking the official free online course provided by ONVIF at [Introduction to ONVIF Course](https://www.onvif.org/about/introduction-to-onvif-course). Please note that we are not endorsed or sponsored by ONVIF, see [Legal Notice](#legal-notice) for details.
 
+## ONVIF CLI
+
+> [!NOTE]
+> The CLI is automatically installed when you install the `onvif-python` see [Installation](#installation). This feature has been available since onvif-python version [0.1.0](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.1)
+
+This library includes a powerful command-line interface (CLI) for interacting with ONVIF devices directly from your terminal. It supports both direct command execution and an interactive shell mode, providing a flexible and efficient way to manage and debug ONVIF devices.
+
+### Features
+
+- **Interactive Shell:** A user-friendly shell with tab completion, command history, and colorized output.
+- **Direct Command Execution:** Run ONVIF commands directly from the terminal for scripting and automation.
+- **Automatic Discovery:** Automatically detects available services on the device.
+- **Connection Management:** Supports HTTP/HTTPS, custom timeouts, and SSL verification.
+- **Data Management:** Store results from commands and use them as parameters in subsequent commands.
+- **Cross-Platform:** Works on Windows, macOS, and Linux.
+
+### Usage
+
+**1. Interactive Mode**
+
+The interactive shell is recommended for exploration and debugging. It provides an intuitive way to navigate services, call methods, and view results.
+
+To start the interactive shell, provide the connection details:
+
+```bash
+onvif --host 192.168.1.17 --port 8000 --username admin --password admin123 -i
+```
+
+If you omit the username or password, you will be prompted to enter them securely.
+
+**Interactive Shell Commands:**
+| Command | Description |
+|---|---|
+| `help` | Show help information |
+| `ls` | List available services or methods in the current context |
+| `cd <service>` | Enter a service mode (e.g., `cd devicemgmt`) |
+| `up` | Go back to the root context |
+| `pwd` | Show the current service context |
+| `desc <method>` | Show documentation for a method |
+| `store <name>` | Store the last result with a variable name |
+| `show <name>` | Display a stored variable |
+| `exit` / `quit` | Exit the shell |
+
+You can see all the commands available in the interactive shell by trying them directly.
+
+**2. Direct Command Execution**
+
+You can also execute a single ONVIF command directly. This is useful for scripting or quick checks.
+
+**Syntax:**
+```bash
+onvif <service> <method> [parameters...] -H <host> -P <port> -u <user> -p <pass>
+```
+
+**Example:**
+```bash
+# Get device capabilities
+onvif devicemgmt GetCapabilities Category=All -H 192.168.1.17 -P 8000 -u admin -p admin123
+
+# Move a PTZ camera
+onvif ptz ContinuousMove ProfileToken=Profile_1 Velocity='{"PanTilt": {"x": 0.1}}' -H 192.168.1.17 -P 8000 -u admin -p admin123
+```
+
+### CLI Parameters
+
+All `ONVIFClient` parameters (like `--timeout`, `--https`, `--cache`, etc.) are available as command-line arguments. Use `onvif --help` to see all available options.
+
 ## ONVIFClient Parameters
 
 The `ONVIFClient` class provides various configuration options to customize the connection behavior, caching strategy, security settings, and debugging capabilities. Below is a detailed description of all available parameters:
@@ -155,9 +229,9 @@ The `ONVIFClient` class provides various configuration options to customize the
 
 | Parameter | Type | Required | Default | Description |
 |-----------|------|----------|---------|-------------|
-| `apply_patch` | `bool` | ❌ No | `True` | Enable zeep patching for better `xsd:any` field parsing and automatic flattening, applied at (>= [`v0.0.4`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.4)) |
-| `capture_xml` | `bool` | ❌ No | `False` | Enable XML capture plugin for debugging SOAP requests/responses, applied at (>= [`v0.0.6`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.6)) |
-| `wsdl_dir`    | `str`  | ❌ No | `None` | Custom WSDL directory path for using external WSDL files instead of built-in ones (e.g., `/path/to/custom/wsdl`), applied at (>= [`v0.1.0`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.0)) |
+| `apply_patch` | `bool` | ❌ No | `True` | Enable zeep patching for better `xsd:any` field parsing and automatic flattening, applied at ([`>=v0.0.4`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.4)) |
+| `capture_xml` | `bool` | ❌ No | `False` | Enable XML capture plugin for debugging SOAP requests/responses, applied at ([`>=v0.0.6`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.6)) |
+| `wsdl_dir`    | `str`  | ❌ No | `None` | Custom WSDL directory path for using external WSDL files instead of built-in ones (e.g., `/path/to/custom/wsdl`), applied at ([`>=v0.1.0`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.0)) |
 
 </details>
 
@@ -390,53 +464,6 @@ else:
 - **GetCapabilities** is **mandatory** for all ONVIF-compliant devices, ensuring broader compatibility
 - **Default URLs** guarantee basic connectivity even with non-compliant devices
 
-**Get detailed service information:**
-
-If you need comprehensive service details, you can manually call `GetServices` with capabilities:
-
-```python
-device = client.devicemgmt()
-
-try:
-    # Try to get detailed service information
-    services = device.GetServices(IncludeCapability=True)
-    for service in services:
-        print(f"Service: {service.Namespace}")
-        print(f"XAddr: {service.XAddr}")
-        if hasattr(service, 'Capabilities'):
-            print(f"Capabilities: {service.Capabilities}")
-except Exception:
-    # Fallback to GetCapabilities for legacy devices
-    capabilities = device.GetCapabilities()
-    print("Capabilities:", capabilities)
-```
-
-**Access capabilities information:**
-
-When using `GetCapabilities` fallback, you can access capability information:
-
-```python
-device = client.devicemgmt()
-
-try:
-    # Get capabilities information from device
-    capabilities = device.GetCapabilities()
-    
-    # Main services (always available)
-    print("Media XAddr:", getattr(capabilities.Media, 'XAddr', 'Not available'))
-    print("PTZ XAddr:", getattr(capabilities.PTZ, 'XAddr', 'Not available'))
-    
-    # Extension services (device-dependent)
-    ext = getattr(capabilities, 'Extension', None)
-    if ext:
-        print("DeviceIO XAddr:", getattr(ext.DeviceIO, 'XAddr', 'Not available'))
-        print("Recording XAddr:", getattr(ext.Recording, 'XAddr', 'Not available'))
-        print("Search XAddr:", getattr(ext.Search, 'XAddr', 'Not available'))
-        print("Replay XAddr:", getattr(ext.Replay, 'XAddr', 'Not available'))
-except Exception as e:
-    print(f"Error getting capabilities: {e}")
-```
-
 > [!TIP]
 > The library handles service discovery automatically with intelligent fallback. You typically don't need to call discovery methods manually unless you need detailed capability information or want to refresh the service list after device configuration changes.
 
@@ -592,8 +619,8 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
 ## Future Improvements (Stay tuned and star ⭐ this repo)
 
 - [x] ~~Add debugging mode with raw xml on SOAP requests and responses.~~ ([c258162](https://github.com/nirsimetri/onvif-python/commit/c258162))
-- [x] ~~Add functionality for `ONVIFClient` to accept a custom `wsdl_dir` service.~~ ([65f2570](https://github.com/nirsimetri/onvif-python/commit/65f257092e4c9daa23dd0d00825ed38a45d23b70))
-- [ ] Add `ONVIF CLI` program to interact directly with ONVIF devices via terminal.
+- [x] ~~Add functionality for `ONVIFClient` to accept a custom `wsdl_dir` service.~~ ([65f2570](https://github.com/nirsimetri/onvif-python/commit/65f2570))
+- [x] ~~Add `ONVIF CLI` program to interact directly with ONVIF devices via terminal.~~ ([645be01](https://github.com/nirsimetri/onvif-python/commit/645be01))
 - [ ] Add asynchronous (async/await) support for non-blocking ONVIF operations and concurrent device communication.
 - [ ] Implement structured data models for ONVIF Schemas using [xsdata](https://github.com/tefra/xsdata).
 - [ ] Integrate [xmltodict](https://github.com/martinblech/xmltodict) for simplified XML parsing and conversion.

{onvif_python-0.1.0 → onvif_python-0.1.1}/onvif/__init__.py

@@ -4,6 +4,14 @@ from .client import ONVIFClient
 from .operator import ONVIFOperator, CacheMode
 from .utils import ONVIFWSDL, ONVIFOperationException, ONVIFErrorHandler, ZeepPatcher
 
+# CLI module is optional - import only if needed
+try:
+    from .cli import main as ONVIFCLI
+
+    CLI_AVAILABLE = True
+except ImportError:
+    CLI_AVAILABLE = False
+
 __all__ = [
     "ONVIFClient",
     "ONVIFOperator",
@@ -13,3 +21,6 @@ __all__ = [
     "ONVIFErrorHandler",
     "ZeepPatcher",
 ]
+
+if CLI_AVAILABLE:
+    __all__.append("ONVIFCLI")

onvif_python-0.1.1/onvif/cli/__init__.py

@@ -0,0 +1,5 @@
+# onvif/cli/__init__.py
+
+from .main import main
+
+__all__ = ["main"]

onvif_python-0.1.1/onvif/cli/__main__.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+# onvif/cli/__main__.py
+
+"""
+ONVIF CLI entry point for python -m onvif.cli
+"""
+
+from .main import main
+
+if __name__ == "__main__":
+    main()