aqpxlib 0.1.0__tar.gz

aqpxlib-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Acute Technology Inc.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

aqpxlib-0.1.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: aqpxlib
+Version: 0.1.0
+Summary: Acute Protocol Exerciser Python Libraries
+Keywords: development
+Author: Eric Tsai, Luke Silva, Duke
+Author-email: Eric Tsai <erictsai@acute.com.tw>, Luke Silva <lukes@acute.com.tw>, Duke <duke@acute.com.tw>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: betterproto==2.0.0b7
+Requires-Dist: pyzmq>=26.2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Acute Protocol Exerciser Python Libraries (AQPXLIB)
+
+[![License](https://img.shields.io/badge/License-BSD_3--Clause-orange.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![PyPI](https://img.shields.io/pypi/v/aqpxlib)](https://pypi.org/project/aqpxlib/)
+
+The **Protocol Exerciser Library** is a friendly interface to interact with Acute's Protocol Exerciser instruments. 
+
+The key features are:
+
+  * **Friendly**: The library is fully written in Python with comprehensive type hints.
+  * **Intuitive**: Actions initiated by these simulated devices are just like real ones.
+  * **Easy to use**: Designed to be easy to use and integrate into your own projects.
+
+## Supported series
+
+| Type | Product Series |
+| ---- | -------------- |
+| Protocol Exerciser | [PX2816B](https://www.acute.com.tw/) |

aqpxlib-0.1.0/README.md

@@ -0,0 +1,18 @@
+# Acute Protocol Exerciser Python Libraries (AQPXLIB)
+
+[![License](https://img.shields.io/badge/License-BSD_3--Clause-orange.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![PyPI](https://img.shields.io/pypi/v/aqpxlib)](https://pypi.org/project/aqpxlib/)
+
+The **Protocol Exerciser Library** is a friendly interface to interact with Acute's Protocol Exerciser instruments. 
+
+The key features are:
+
+  * **Friendly**: The library is fully written in Python with comprehensive type hints.
+  * **Intuitive**: Actions initiated by these simulated devices are just like real ones.
+  * **Easy to use**: Designed to be easy to use and integrate into your own projects.
+
+## Supported series
+
+| Type | Product Series |
+| ---- | -------------- |
+| Protocol Exerciser | [PX2816B](https://www.acute.com.tw/) |

aqpxlib-0.1.0/pyproject.toml

@@ -0,0 +1,127 @@
+[build-system]
+requires = ["uv_build >= 0.9.5, <0.10.0"]
+build-backend = "uv_build"
+
+[project]
+name = "aqpxlib"
+version = "0.1.0"
+description = "Acute Protocol Exerciser Python Libraries"
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+readme = "README.md"
+authors = [
+    { name = "Eric Tsai", email = "erictsai@acute.com.tw" },
+    { name = "Luke Silva", email = "lukes@acute.com.tw" },
+    { name = "Duke", email = "duke@acute.com.tw" },
+]
+keywords = [ "development" ]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development",
+    "Topic :: Software Development :: Libraries",
+    "License :: OSI Approved :: BSD License",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "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",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "betterproto==2.0.0b7",
+    "pyzmq>=26.2.0",
+]
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+respect-gitignore = true
+src = ["src"]
+exclude = [
+    ".git",
+    "__pycache__",
+    ".venv",
+    "tests",
+    "tools",
+]
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "ANN002",  # Missing type annotation for *{name}
+    "ANN003",  # Missing type annotation for **{name}
+    "ANN201",  # Missing return type annotation for public function {name}
+    "ANN202",  # Missing return type annotation for private function {name}
+    "ANN204",  # Missing return type annotation for special method {name}
+    "ARG002",  # Unused method argument: {name}
+    "B006",    # Do not use mutable data structures for argument defaults
+    "B026",    # Star-arg unpacking after a keyword argument is strongly discouraged
+    "FBT001",  # Boolean-typed positional argument in function definition
+    "FBT002",  # Boolean default positional argument in function definition
+    "FIX001",  # Line contains FIXME, consider resolving the issue
+    "FIX002",  # Line contains TODO, consider resolving the issue
+    "PLR0913", # Too many arguments in function definition ({c_args} > {max_args})
+    "PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
+    "PLW1641", # Object does not implement __hash__ method
+    "S101",    # Use of assert detected
+    "TD001",   # Invalid TODO tag
+    "TD002",   # Missing author in TODO
+    "TD003",   # Missing issue link for this TODO
+    "TRY003",  # Avoid specifying long messages outside the exception class
+    "TRY401",  # Redundant exception object included in logging.exception call
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[dependency-groups]
+dev = [
+    "betterproto[compiler]==2.0.0b7",
+    "grpcio>=1.72.1",
+    "grpcio-tools>=1.72.1",
+    "mkdocs>=1.6.1",
+    "mkdocs-autorefs>=1.4.3",
+    "mkdocs-get-deps>=0.2.0",
+    "mkdocs-material>=9.6.22",
+    "mkdocs-material-extensions>=1.3.1",
+    "mkdocstrings>=0.30.1",
+    "mkdocstrings-python>=1.18.2",
+    "pytest>=8.4.2",
+    "ruff>=0.14.2",
+    "ty>=0.0.1a33",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["aqpxlib"]
+
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
+
+[tool.ty.src]
+include = [
+    "src",
+]
+
+[tool.ty.rules]
+# Ignore these rules for now, we will fix them in the future.
+possibly-missing-attribute = "ignore"
+invalid-method-override = "ignore"
+invalid-argument-type = "ignore"
+invalid-return-type = "ignore"
+invalid-assignment = "ignore"
+unresolved-attribute = "ignore"
+parameter-already-assigned = "ignore"
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true

aqpxlib-0.1.0/src/aqpxlib/__init__.py

@@ -0,0 +1,8 @@
+# Copyright 2025 Acute Technology Inc. All rights reserved.
+# SPDX-License-Identifier: BSD-3-Clause
+"""Acute Protocol Exerciser Library."""
+
+from .toplevel import AqProtocolExerciser
+
+__version__ = "0.0.1"
+__all__ = ["AqProtocolExerciser"]

aqpxlib-0.1.0/src/aqpxlib/abstract/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2025 Acute Technology Inc. All rights reserved.
+# SPDX-License-Identifier: BSD-3-Clause
+"""Acute Protocol Exerciser Bus Instances."""
+
+from aqpxlib.abstract.abstract_bus import PxAbstractBus
+from aqpxlib.abstract.abstract_device import PxAbstractController, PxAbstractDevice, PxAbstractTarget
+
+__all__ = [
+    "PxAbstractBus",
+    "PxAbstractController",
+    "PxAbstractDevice",
+    "PxAbstractTarget",
+]