onvif-python 0.0.4__tar.gz → 0.0.6__tar.gz

{onvif_python-0.0.4/onvif_python.egg-info → onvif_python-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onvif-python
-Version: 0.0.4
+Version: 0.0.6
 Summary: A comprehensive and developer-friendly Python library for working with ONVIF-compliant devices
 Author-email: Nirsimetri Technologies® <open@nirsimetri.com>
 Maintainer: Kaburagi
@@ -10,8 +10,8 @@ Project-URL: Issues, https://github.com/nirsimetri/onvif-python/issues
 Project-URL: Documentation, https://deepwiki.com/nirsimetri/onvif-python
 Project-URL: Repository, https://github.com/nirsimetri/onvif-python.git
 Project-URL: Changelog, https://github.com/nirsimetri/onvif-python/releases
-Keywords: ONVIF,onvif,Camera,onvif-python,ip-camera,cctv,soap,surveillance,cctv cameras,soap-client,onvif-client,onvif-library,onvif-specifications
-Classifier: Development Status :: 3 - Alpha
+Keywords: onvif,Camera,onvif-python,ip-camera,cctv,soap,surveillance,cctv cameras,soap-client,onvif-client,onvif-library,onvif-specifications
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
@@ -25,7 +25,9 @@ Classifier: Topic :: Security
 Classifier: Topic :: Multimedia :: Video
 Classifier: Topic :: Multimedia :: Sound/Audio
 Classifier: Topic :: Communications
+Classifier: Topic :: Text Processing :: Markup :: XML
 Classifier: Natural Language :: English
+Classifier: Natural Language :: Indonesian
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
@@ -41,9 +43,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.0.4-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
+[![Release](https://img.shields.io/badge/Release-v0.0.6-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
 <br>
-[![PyPI](https://img.shields.io/badge/PyPI-0.0.4-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.0.6-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)
 
 Are you having trouble finding a Python ONVIF library that supports your device?  
@@ -148,32 +150,64 @@ 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.
 
-## Device Verification: Why Use GetCapabilities First?
+## Service Discovery: Understanding Device Capabilities
 
 > [!WARNING]
-> Before performing any operations on an ONVIF device, it is highly recommended to verify which capabilities and services are available and supported by the device using the `GetCapabilities` method from `devicemgmt()` service instance. This step ensures that your application interacts only with features that the device actually implements, preventing errors and improving compatibility.
+> Before performing any operations on an ONVIF device, it is highly recommended to discover which services are available and supported by the device. This library automatically uses `GetServices` during initialization to discover service endpoints, but you can also query services manually for detailed information including capabilities.
 
-**Why verify device capabilities with GetCapabilities?**
+**Why discover device services?**
 
-- **Device Diversity:** Not all ONVIF devices support every capability or service. Capabilities may vary by manufacturer, model, firmware, or configuration.
-- **Error Prevention:** Attempting to use unsupported features can result in failed requests, exceptions, or undefined behavior.
-- **Dynamic Feature Detection:** Devices may enable or disable capabilities over time (e.g., after firmware updates or configuration changes).
-- **Optimized Integration:** By checking available capabilities, your application can adapt its workflow and UI to match the device's actual features.
+- **Device Diversity:** Not all ONVIF devices support every service. Available services may vary by manufacturer, model, firmware, or configuration.
+- **Error Prevention:** Attempting to use unsupported services can result in failed requests, exceptions, or undefined behavior.
+- **Dynamic Feature Detection:** Devices may enable or disable services over time (e.g., after firmware updates or configuration changes).
+- **Optimized Integration:** By checking available services, your application can adapt its workflow and UI to match the device's actual features.
 
-**How to verify device capabilities:**
+**How service discovery works in this library:**
 
-Call `GetCapabilities` on your `devicemgmt()` instance:
+The `ONVIFClient` automatically calls `GetServices` during initialization to build a service map. This map is used internally to resolve service endpoints:
 
 ```python
 from onvif import ONVIFClient
 
 client = ONVIFClient("192.168.1.17", 8000, "admin", "admin123")
+
+# Access the discovered services
+print(client.services)
+# Example output: [{'Namespace': 'http://www.onvif.org/ver10/device/wsdl', 'XAddr': '...', 'Version': {...}}, ...]
+
+# Check the service map (namespace -> XAddr mapping)
+print(client._service_map)
+# Example output: {'http://www.onvif.org/ver10/media/wsdl': 'http://192.168.1.17:8000/onvif/Media', ...}
+```
+
+**Get detailed service information with capabilities:**
+
+If you need detailed capability information for each service, call `GetServices` with `IncludeCapability=True`:
+
+```python
+device = client.devicemgmt()
+services = device.GetServices(IncludeCapability=True)
+
+for service in services:
+    print(f"Service: {service.Namespace}")
+    print(f"Endpoint: {service.XAddr}")
+    print(f"Version: {service.Version.Major}.{service.Version.Minor}")
+    if hasattr(service, 'Capabilities') and service.Capabilities:
+        print(f"Capabilities: {service.Capabilities}")
+```
+
+**Alternative: Use GetCapabilities for legacy compatibility:**
+
+For backward compatibility or when you need a quick overview of major service categories, you can still use `GetCapabilities`:
+
+```python
 capabilities = client.devicemgmt().GetCapabilities()
 print(capabilities)
-# Example output: {'Media': {'XAddr': 'http://192.168.1.17:8000/onvif/media_service', ...}, 'PTZ': {...}, ...}
+# Example output: {'Media': {'XAddr': '...', ...}, 'PTZ': {...}, 'Events': {...}, ...}
 ```
 
-Review the returned dictionary to determine which capabilities and services (e.g., Media, PTZ, Analytics) are available before invoking further operations.
+> [!TIP]
+> The library handles service discovery automatically, so you typically don't need to call `GetServices` manually unless you need detailed capability information or want to refresh the service list after device configuration changes.
 
 ## Tested Devices
 
@@ -283,6 +317,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    client.events()                    # root binding
    client.pullpoint(subscription)     # sub-binding (dynamic, via SubscriptionReference.Address)
    client.subscription(subscription)  # sub-binding (dynamic, via SubscriptionReference.Address)
+   client.notification()              # sub-binding accessor
    ```
 
 2. **Security (Advanced Security)**
@@ -290,7 +325,6 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    - **Sub-bindings:**
      - `AuthorizationServerBinding`
      - `KeystoreBinding`
-     - `CredentialBinding`
      - `JWTBinding`
      - `Dot1XBinding`
      - `TLSServerBinding`
@@ -300,7 +334,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    ```python
    client.security()                  # root binding
    client.authorizationserver(xaddr)  # sub-binding accessor (requires xAddr)
-   client.keystore(xaddr)
+   client.keystore(xaddr)             # ..
    client.jwt(xaddr)
    client.dot1x(xaddr)
    client.tlsserver(xaddr)
@@ -326,10 +360,12 @@ 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))
+- [ ] Add functionality for `ONVIFClient` to accept a custom `wsdl_path` service.
+- [ ] Add asynchronous (async/await) support for non-blocking ONVIF operations and concurrent device communication.
+- [ ] Add `ONVIF CLI` program to interact directly with ONVIF devices via terminal.
 - [ ] 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.
-- [ ] Add functionality for `ONVIFClient` to accept a custom `wsdl_path` service.
-- [ ] Add debugging mode with raw xml on SOAP requests and responses.
 - [ ] Enhance documentation with API references and diagrams (not from [AI Wiki](https://deepwiki.com/nirsimetri/onvif-python)).
 - [ ] Add more usage examples for advanced features.
 - [ ] Add benchmarking and performance metrics.

{onvif_python-0.0.4 → onvif_python-0.0.6}/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.0.4-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
+[![Release](https://img.shields.io/badge/Release-v0.0.6-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
 <br>
-[![PyPI](https://img.shields.io/badge/PyPI-0.0.4-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.0.6-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)
 
 Are you having trouble finding a Python ONVIF library that supports your device?  
@@ -109,32 +109,64 @@ 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.
 
-## Device Verification: Why Use GetCapabilities First?
+## Service Discovery: Understanding Device Capabilities
 
 > [!WARNING]
-> Before performing any operations on an ONVIF device, it is highly recommended to verify which capabilities and services are available and supported by the device using the `GetCapabilities` method from `devicemgmt()` service instance. This step ensures that your application interacts only with features that the device actually implements, preventing errors and improving compatibility.
+> Before performing any operations on an ONVIF device, it is highly recommended to discover which services are available and supported by the device. This library automatically uses `GetServices` during initialization to discover service endpoints, but you can also query services manually for detailed information including capabilities.
 
-**Why verify device capabilities with GetCapabilities?**
+**Why discover device services?**
 
-- **Device Diversity:** Not all ONVIF devices support every capability or service. Capabilities may vary by manufacturer, model, firmware, or configuration.
-- **Error Prevention:** Attempting to use unsupported features can result in failed requests, exceptions, or undefined behavior.
-- **Dynamic Feature Detection:** Devices may enable or disable capabilities over time (e.g., after firmware updates or configuration changes).
-- **Optimized Integration:** By checking available capabilities, your application can adapt its workflow and UI to match the device's actual features.
+- **Device Diversity:** Not all ONVIF devices support every service. Available services may vary by manufacturer, model, firmware, or configuration.
+- **Error Prevention:** Attempting to use unsupported services can result in failed requests, exceptions, or undefined behavior.
+- **Dynamic Feature Detection:** Devices may enable or disable services over time (e.g., after firmware updates or configuration changes).
+- **Optimized Integration:** By checking available services, your application can adapt its workflow and UI to match the device's actual features.
 
-**How to verify device capabilities:**
+**How service discovery works in this library:**
 
-Call `GetCapabilities` on your `devicemgmt()` instance:
+The `ONVIFClient` automatically calls `GetServices` during initialization to build a service map. This map is used internally to resolve service endpoints:
 
 ```python
 from onvif import ONVIFClient
 
 client = ONVIFClient("192.168.1.17", 8000, "admin", "admin123")
+
+# Access the discovered services
+print(client.services)
+# Example output: [{'Namespace': 'http://www.onvif.org/ver10/device/wsdl', 'XAddr': '...', 'Version': {...}}, ...]
+
+# Check the service map (namespace -> XAddr mapping)
+print(client._service_map)
+# Example output: {'http://www.onvif.org/ver10/media/wsdl': 'http://192.168.1.17:8000/onvif/Media', ...}
+```
+
+**Get detailed service information with capabilities:**
+
+If you need detailed capability information for each service, call `GetServices` with `IncludeCapability=True`:
+
+```python
+device = client.devicemgmt()
+services = device.GetServices(IncludeCapability=True)
+
+for service in services:
+    print(f"Service: {service.Namespace}")
+    print(f"Endpoint: {service.XAddr}")
+    print(f"Version: {service.Version.Major}.{service.Version.Minor}")
+    if hasattr(service, 'Capabilities') and service.Capabilities:
+        print(f"Capabilities: {service.Capabilities}")
+```
+
+**Alternative: Use GetCapabilities for legacy compatibility:**
+
+For backward compatibility or when you need a quick overview of major service categories, you can still use `GetCapabilities`:
+
+```python
 capabilities = client.devicemgmt().GetCapabilities()
 print(capabilities)
-# Example output: {'Media': {'XAddr': 'http://192.168.1.17:8000/onvif/media_service', ...}, 'PTZ': {...}, ...}
+# Example output: {'Media': {'XAddr': '...', ...}, 'PTZ': {...}, 'Events': {...}, ...}
 ```
 
-Review the returned dictionary to determine which capabilities and services (e.g., Media, PTZ, Analytics) are available before invoking further operations.
+> [!TIP]
+> The library handles service discovery automatically, so you typically don't need to call `GetServices` manually unless you need detailed capability information or want to refresh the service list after device configuration changes.
 
 ## Tested Devices
 
@@ -244,6 +276,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    client.events()                    # root binding
    client.pullpoint(subscription)     # sub-binding (dynamic, via SubscriptionReference.Address)
    client.subscription(subscription)  # sub-binding (dynamic, via SubscriptionReference.Address)
+   client.notification()              # sub-binding accessor
    ```
 
 2. **Security (Advanced Security)**
@@ -251,7 +284,6 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    - **Sub-bindings:**
      - `AuthorizationServerBinding`
      - `KeystoreBinding`
-     - `CredentialBinding`
      - `JWTBinding`
      - `Dot1XBinding`
      - `TLSServerBinding`
@@ -261,7 +293,7 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
    ```python
    client.security()                  # root binding
    client.authorizationserver(xaddr)  # sub-binding accessor (requires xAddr)
-   client.keystore(xaddr)
+   client.keystore(xaddr)             # ..
    client.jwt(xaddr)
    client.dot1x(xaddr)
    client.tlsserver(xaddr)
@@ -287,10 +319,12 @@ 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))
+- [ ] Add functionality for `ONVIFClient` to accept a custom `wsdl_path` service.
+- [ ] Add asynchronous (async/await) support for non-blocking ONVIF operations and concurrent device communication.
+- [ ] Add `ONVIF CLI` program to interact directly with ONVIF devices via terminal.
 - [ ] 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.
-- [ ] Add functionality for `ONVIFClient` to accept a custom `wsdl_path` service.
-- [ ] Add debugging mode with raw xml on SOAP requests and responses.
 - [ ] Enhance documentation with API references and diagrams (not from [AI Wiki](https://deepwiki.com/nirsimetri/onvif-python)).
 - [ ] Add more usage examples for advanced features.
 - [ ] Add benchmarking and performance metrics.

{onvif_python-0.0.4 → onvif_python-0.0.6}/onvif/__init__.py

@@ -12,6 +12,6 @@ __all__ = [
     "ONVIFWSDL",
     "ONVIFOperationException",
     "apply_patch",
-    "remove_patch", 
+    "remove_patch",
     "is_patched",
-]
+]