tdl-xoa-driver 1.1.0__tar.gz → 1.2.0__tar.gz

{tdl_xoa_driver-1.1.0/tdl_xoa_driver.egg-info → tdl_xoa_driver-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: tdl-xoa-driver
-Version: 1.1.0
+Version: 1.2.0
 Summary: XOA Driver is a Python library providing user-friendly communication interfaces to Xena Traffic Generation test equipment. It provides a rich collection of programming interfaces that can be used to either write test scripts or develop applications.
 Home-page: https://github.com/xenanetworks/tdl-xoa-driver
 Author: Leonard Yu
@@ -12,12 +12,11 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: author
@@ -27,6 +26,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license
+Dynamic: license-file
 Dynamic: maintainer
 Dynamic: maintainer-email
 Dynamic: requires-python
@@ -54,121 +54,3 @@ The user documentation is hosted:
 * Supporting server-to-client push notification, and event subscription, to reduce user code complexity.
 * Covering commands of Xena testers, including Xena Valkyrie, Vulcan, and Chimera.
 * Supporting IDE auto-complete with built-in class/function/API use manual, to increase development efficiency.
-
-
-## Installation
-
-### Install Using `pip`
-Make sure Python `pip` is installed on you system. If you are using virtualenv, then pip is already installed into environments created by virtualenv, and using sudo is not needed. If you do not have pip installed, download this file: https://bootstrap.pypa.io/get-pip.py and run `python get-pip.py`.
-
-To install the latest, use pip to install from pypi:
-``` shell
-~/> pip install tdl-xoa-driver
-```
-
-To upgrade to the latest, use pip to upgrade from pypi:
-``` shell
-~/> pip install tdl-xoa-driver --upgrade
-```
-
-### Install From Source Code
-Make sure these packages are installed ``wheel``, ``setuptools`` on your system.
-
-Install ``setuptools`` using pip:
-``` shell
-~/> pip install wheel setuptools
-```
-
-To install source of python packages:
-``` shell
-/xoa_driver> python setup.py install
-```
-
-To build ``.whl`` file for distribution:
-``` shell
-/xoa_driver> python setup.py bdist_wheel
-```
-
-
-## Quick Start
-
-* Get Python pip if not already installed (Download https://bootstrap.pypa.io/get-pip.py):
-    `python get-pip.py`
-
-* Install the latest tdl-xoa-driver:
-    `pip install tdl-xoa-driver -U`
-
-* Write Python code to manage with Xena testers:
-```python
-import asyncio
-
-from xoa_driver import testers
-from xoa_driver import modules
-from xoa_driver import ports
-from xoa_driver import enums
-from xoa_driver import utils
-
-async def my_awesome_func():
-    # Establish connection with a Valkyrie tester
-    async with testers.L23Tester("10.10.10.10", "JonDoe") as tester:
-        # Get the port 0/0 (module 0)
-        port = await tester.modules.obtain(0).ports.obtain(0)
-
-        # Reserve the port
-        await port.reservation.set_reserve()
-
-        # Reset the port
-        await port.reset.set()
-
-        # Create a stream on the port
-        stream = await port.streams.create()
-
-        # Prepare stream header protocol
-        header_protocol = [enums.ProtocolOption.ETHERNET, enums.ProtocolOption.IP]
-
-        # Batch configure the stream
-        await utils.apply(
-            stream.tpld_id.set(0), # Create the TPLD index of stream
-            stream.packet.length.set(*size), # Configure the packet size
-            stream.packet.header.protocol.set(header_protocol), # Configure the packet type
-            stream.packet.header.data.set(header), # Configure the packet header
-            stream.enable.set_on(), # Enable streams
-            stream.rate.fraction.set(1000000) # Configure the stream rate 100%
-        )
-
-        # Clear statistics
-        await utils.apply(
-            port.statistics.tx.clear.set(),
-            port.statistics.rx.clear.set()
-        )
-
-        # Start traffic on the port
-        await port.traffic.state.set_start()
-
-        # Test duration 10 seconds
-        await asyncio.sleep(10)
-
-        # Query TX statistics
-        tx_result = await port.statistics.tx.total.get()
-        print(f"bit count last second: {tx_result.bit_count_last_sec}")
-        print(f"packet count last second: {tx_result.packet_count_last_sec}")
-        print(f"byte count since cleared: {tx_result.byte_count_since_cleared}")
-        print(f"packet count since cleared: {tx_result.packet_count_since_cleared}")
-
-        # Stop traffic on the port
-        await port.traffic.state.set_stop()
-
-        # Release the port
-        await port.reservation.set_release()
-
-def main():
-    try:
-        loop = asyncio.get_event_loop()
-        loop.create_task(my_awesome_func())
-        loop.run_forever()
-    except KeyboardInterrupt:
-        pass
-
-if __name__ == "__main__":
-    main()
-```

tdl_xoa_driver-1.2.0/README.md

@@ -0,0 +1,22 @@
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tdl-xoa-driver) [![PyPI](https://img.shields.io/pypi/v/tdl-xoa-driver)](https://pypi.python.org/pypi/tdl-xoa-driver) [![Documentation Status](https://readthedocs.com/projects/xena-networks-tdl-xoa-driver/badge/?version=latest)](https://docs.xenanetworks.com/projects/tdl-xoa-driver/en/latest/?badge=latest)
+# XOA Driver
+XOA Driver is a standalone Python library that provides a user-friendly and powerful interface for automating network testing tasks using Xena Networks test equipment. Xena test equipment is a high-performance network test device designed for testing and measuring the performance of network equipment and applications.
+
+## Introduction
+The XOA Driver is designed to be easy to use and integrate with other automation tools and frameworks. It provides a comprehensive set of methods and classes for interacting with Xena test equipment, including the ability to create and run complex test scenarios, generate and analyze traffic at line rate, and perform detailed analysis of network performance and behavior.
+
+The XOA Driver simplifies the process of automating network testing tasks using Xena test equipment. It provides a simple, yet powerful, interface for interacting with Xena test equipment using the Python programming language. With the XOA Driver, network engineers and testing professionals can easily create and execute test scenarios, generate and analyze traffic, and perform detailed analysis of network performance and behavior, all while leveraging the power and flexibility of the Python programming language.
+
+Overall, the XOA Driver is a valuable tool for anyone looking to automate their network testing tasks using Xena test equipment. With its simple, yet powerful, interface and support for the Python programming language, the XOA Driver provides a flexible and extensible framework for automating network testing tasks and improving the quality of network infrastructure.
+
+## Documentation
+The user documentation is hosted:
+[XOA Driver Documentation](https://docs.xenanetworks.com/projects/tdl-xoa-driver)
+
+## Key Features
+* Objected-oriented, high-level abstraction, to help users save time on parsing command responses.
+* Supporting sending commands in batches to increase code execution efficiency.
+* Automatically matching command requests and server response, providing clear information in case a command gets an error response.
+* Supporting server-to-client push notification, and event subscription, to reduce user code complexity.
+* Covering commands of Xena testers, including Xena Valkyrie, Vulcan, and Chimera.
+* Supporting IDE auto-complete with built-in class/function/API use manual, to increase development efficiency.

{tdl_xoa_driver-1.1.0 → tdl_xoa_driver-1.2.0}/setup.py

@@ -27,13 +27,12 @@ def main():
             "Intended Audience :: Developers",
             "Topic :: Software Development :: Libraries :: Python Modules",
             "License :: OSI Approved :: Apache Software License",
-            "Programming Language :: Python :: 3.9",
-            "Programming Language :: Python :: 3.10",
             "Programming Language :: Python :: 3.11",
             "Programming Language :: Python :: 3.12",
             "Programming Language :: Python :: 3.13",
+            "Programming Language :: Python :: 3.14",
         ],
-        python_requires=">=3.9",
+        python_requires=">=3.11",
     )
 
 

{tdl_xoa_driver-1.1.0 → tdl_xoa_driver-1.2.0/tdl_xoa_driver.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: tdl-xoa-driver
-Version: 1.1.0
+Version: 1.2.0
 Summary: XOA Driver is a Python library providing user-friendly communication interfaces to Xena Traffic Generation test equipment. It provides a rich collection of programming interfaces that can be used to either write test scripts or develop applications.
 Home-page: https://github.com/xenanetworks/tdl-xoa-driver
 Author: Leonard Yu
@@ -12,12 +12,11 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: author
@@ -27,6 +26,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license
+Dynamic: license-file
 Dynamic: maintainer
 Dynamic: maintainer-email
 Dynamic: requires-python
@@ -54,121 +54,3 @@ The user documentation is hosted:
 * Supporting server-to-client push notification, and event subscription, to reduce user code complexity.
 * Covering commands of Xena testers, including Xena Valkyrie, Vulcan, and Chimera.
 * Supporting IDE auto-complete with built-in class/function/API use manual, to increase development efficiency.
-
-
-## Installation
-
-### Install Using `pip`
-Make sure Python `pip` is installed on you system. If you are using virtualenv, then pip is already installed into environments created by virtualenv, and using sudo is not needed. If you do not have pip installed, download this file: https://bootstrap.pypa.io/get-pip.py and run `python get-pip.py`.
-
-To install the latest, use pip to install from pypi:
-``` shell
-~/> pip install tdl-xoa-driver
-```
-
-To upgrade to the latest, use pip to upgrade from pypi:
-``` shell
-~/> pip install tdl-xoa-driver --upgrade
-```
-
-### Install From Source Code
-Make sure these packages are installed ``wheel``, ``setuptools`` on your system.
-
-Install ``setuptools`` using pip:
-``` shell
-~/> pip install wheel setuptools
-```
-
-To install source of python packages:
-``` shell
-/xoa_driver> python setup.py install
-```
-
-To build ``.whl`` file for distribution:
-``` shell
-/xoa_driver> python setup.py bdist_wheel
-```
-
-
-## Quick Start
-
-* Get Python pip if not already installed (Download https://bootstrap.pypa.io/get-pip.py):
-    `python get-pip.py`
-
-* Install the latest tdl-xoa-driver:
-    `pip install tdl-xoa-driver -U`
-
-* Write Python code to manage with Xena testers:
-```python
-import asyncio
-
-from xoa_driver import testers
-from xoa_driver import modules
-from xoa_driver import ports
-from xoa_driver import enums
-from xoa_driver import utils
-
-async def my_awesome_func():
-    # Establish connection with a Valkyrie tester
-    async with testers.L23Tester("10.10.10.10", "JonDoe") as tester:
-        # Get the port 0/0 (module 0)
-        port = await tester.modules.obtain(0).ports.obtain(0)
-
-        # Reserve the port
-        await port.reservation.set_reserve()
-
-        # Reset the port
-        await port.reset.set()
-
-        # Create a stream on the port
-        stream = await port.streams.create()
-
-        # Prepare stream header protocol
-        header_protocol = [enums.ProtocolOption.ETHERNET, enums.ProtocolOption.IP]
-
-        # Batch configure the stream
-        await utils.apply(
-            stream.tpld_id.set(0), # Create the TPLD index of stream
-            stream.packet.length.set(*size), # Configure the packet size
-            stream.packet.header.protocol.set(header_protocol), # Configure the packet type
-            stream.packet.header.data.set(header), # Configure the packet header
-            stream.enable.set_on(), # Enable streams
-            stream.rate.fraction.set(1000000) # Configure the stream rate 100%
-        )
-
-        # Clear statistics
-        await utils.apply(
-            port.statistics.tx.clear.set(),
-            port.statistics.rx.clear.set()
-        )
-
-        # Start traffic on the port
-        await port.traffic.state.set_start()
-
-        # Test duration 10 seconds
-        await asyncio.sleep(10)
-
-        # Query TX statistics
-        tx_result = await port.statistics.tx.total.get()
-        print(f"bit count last second: {tx_result.bit_count_last_sec}")
-        print(f"packet count last second: {tx_result.packet_count_last_sec}")
-        print(f"byte count since cleared: {tx_result.byte_count_since_cleared}")
-        print(f"packet count since cleared: {tx_result.packet_count_since_cleared}")
-
-        # Stop traffic on the port
-        await port.traffic.state.set_stop()
-
-        # Release the port
-        await port.reservation.set_release()
-
-def main():
-    try:
-        loop = asyncio.get_event_loop()
-        loop.create_task(my_awesome_func())
-        loop.run_forever()
-    except KeyboardInterrupt:
-        pass
-
-if __name__ == "__main__":
-    main()
-```

tdl_xoa_driver-1.2.0/xoa_driver/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "1.2.0"
+__short_version__ = "1.2"

{tdl_xoa_driver-1.1.0 → tdl_xoa_driver-1.2.0}/xoa_driver/functions/anlt.py

@@ -271,8 +271,6 @@ async def lt_coeff_inc(
     emphasis: enums.LinkTrainCoeffs
 ) -> enums.LinkTrainCmdResults:
     """
-    .. versionadded:: 1.1
-
     Ask the remote port to increase coeff of the specified serdes.
 
     :param port: the port object
@@ -293,8 +291,6 @@ async def lt_coeff_dec(
     emphasis: enums.LinkTrainCoeffs
 ) -> enums.LinkTrainCmdResults:
     """
-    .. versionadded:: 1.1
-
     Ask the remote port to decrease coeff of the specified serdes.
 
     :param port: the port object
@@ -316,8 +312,6 @@ async def lt_coeff_no_eq(
 ) -> enums.LinkTrainCmdResults:
 
     """
-    .. versionadded:: 2.0
-
     Ask the remote port to set the coeff to NO_EQ on the specified serdes.
 
     :param port: the port object
@@ -338,8 +332,6 @@ async def lt_preset(
     preset: enums.LinkTrainPresets
 ) -> enums.LinkTrainCmdResults:
     """
-    .. versionadded:: 1.1
-
     Ask the remote port to use the preset of the specified serdes.
 
     :param port: the port object
@@ -360,8 +352,6 @@ async def lt_encoding(
     encoding: enums.LinkTrainEncoding
 ) -> enums.LinkTrainCmdResults:
     """
-    .. versionadded:: 1.1
-
     Ask the remote port to use the encoding of the specified serdes.
 
     :param port: the port object
@@ -378,8 +368,6 @@ async def lt_encoding(
 
 async def lt_trained(port: GenericL23Port, serdes: int) -> enums.LinkTrainCmdResults:
     """
-    .. versionadded:: 1.1
-
     Tell the remote port that the current serdes is trained.
 
     :param port: the port object
@@ -431,8 +419,6 @@ async def lt_status(port: GenericL23Port, serdes: int) -> dict[str, t.Any]:
 
 async def txtap_get(port: GenericL23Port, serdes: int) -> dict[str, int]:
     """
-    .. versionadded:: 1.1
-
     Get the tap value of the local TX tap.
 
     :param port: the port object
@@ -457,8 +443,6 @@ async def txtap_set(
     post1: int,
 ) -> None:
     """
-    .. versionadded:: 1.1
-
     Set the tap value of the local TX tap.
 
     :param port: the port object
@@ -545,8 +529,6 @@ async def anlt_status(port: GenericL23Port) -> dict[str, t.Any]:
 
 async def anlt_log(port: GenericL23Port) -> str:
     """
-    .. versionadded:: 1.1
-
     Get the anlt log messages
 
     :param port: the port object
@@ -578,8 +560,6 @@ async def anlt_stop(port: GenericL23Port) -> None:
 
 async def txtap_autotune(port: GenericL23Port, serdes: int) -> None:
     """
-    .. versionadded:: 1.3
-
     Auto tune the tap value of the local TX tap.
 
     :param port: the port object
@@ -597,8 +577,6 @@ async def txtap_autotune(port: GenericL23Port, serdes: int) -> None:
 
 async def lt_im_status(port: GenericL23Port) -> dict[str, t.Any]:
     """
-    .. versionadded:: 1.3
-
     Get LT initial modulation config
 
     :param port: the port object
@@ -621,8 +599,6 @@ async def lt_im_status(port: GenericL23Port) -> dict[str, t.Any]:
 
 async def lt_algorithm_status(port: GenericL23Port) -> dict[str, t.Any]:
     """
-    .. versionadded:: 1.3
-
     Get LT initial modulation config
 
     :param port: the port object
@@ -645,8 +621,6 @@ async def lt_algorithm_status(port: GenericL23Port) -> dict[str, t.Any]:
 
 async def anlt_strict(port: GenericL23Port, enable: bool) -> None:
     """
-    .. versionadded:: 1.3
-
     Should ANLT strict mode be enabled
 
     :param port: the port object
@@ -671,8 +645,6 @@ async def anlt_strict(port: GenericL23Port, enable: bool) -> None:
 
 async def anlt_log_control(port: GenericL23Port, types: t.List[enums.AnLtLogControl]) -> None:
     """
-    .. versionadded:: 1.3
-
     Control what should be logged for ANLT by xenaserver
 
     :param port: the port object
@@ -699,8 +671,6 @@ async def anlt_log_control(port: GenericL23Port, types: t.List[enums.AnLtLogCont
 
 async def anlt_log_control_get(port: GenericL23Port) -> dict[str, bool]:
     """
-    .. versionadded:: 2.7
-
     Get ANLT log control config
 
     :param port: the port object