protocol-validation-suite-framework-apis 26.7.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. protocol_validation_suite_framework_apis-26.7.1/LICENSE +53 -0
  2. protocol_validation_suite_framework_apis-26.7.1/PKG-INFO +116 -0
  3. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/CODE_REVIEW_REPORT.md +616 -0
  4. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/__init__.py +9 -0
  5. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/_client.py +596 -0
  6. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/_decorators.py +43 -0
  7. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/_utils.py +66 -0
  8. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/models.py +103 -0
  9. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/paths.json +4 -0
  10. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/protocol_validation_suite_apis.py +167 -0
  11. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/stubs/GRPC_pb2.py +104 -0
  12. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/stubs/GRPC_pb2_grpc.py +951 -0
  13. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/stubs/__init__.py +0 -0
  14. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_APIs/stubs/protos/gRPC.proto +246 -0
  15. protocol_validation_suite_framework_apis-26.7.1/Protocol_Validation_Suite_Examples/example_caller.py +125 -0
  16. protocol_validation_suite_framework_apis-26.7.1/README.md +98 -0
  17. protocol_validation_suite_framework_apis-26.7.1/pyproject.toml +34 -0
@@ -0,0 +1,53 @@
1
+ This is a proprietary license
2
+
3
+ Soliton Protocol Validation Suite Framework APIs for Python — Supplemental License
4
+ Copyright © 2026 Soliton Technologies Private Limited. All rights reserved.
5
+
6
+ Scope
7
+ This Supplement governs your use of the Soliton Protocol Validation Suite Framework
8
+ APIs for Python ("Supplement"), which is designed solely for use with the Soliton
9
+ Protocol Validation Suite Tool Software ("Software").
10
+
11
+ 1. LICENSE
12
+ Subject to the terms of the Soliton Protocol Validation Suite Tool End User License
13
+ Agreement ("EULA"), Soliton Technologies grants you a limited, non-exclusive,
14
+ non-transferable, revocable license to use this Supplement solely in conjunction with
15
+ the Software for your internal business purposes.
16
+
17
+ 2. RESTRICTIONS
18
+ You may not:
19
+ * Copy, modify, adapt, or create derivative works of this Supplement
20
+ * Distribute, sublicense, sell, resell, transfer, or otherwise make the Supplement
21
+ available to any third party
22
+ * Reverse engineer, decompile, disassemble, or attempt to derive the source code of
23
+ this Supplement
24
+ * Use this Supplement independently of or separately from the Software
25
+ * Remove or alter any proprietary notices, labels, or markings
26
+
27
+ 3. DISCLAIMER
28
+ THIS SUPPLEMENT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. SOLITON TECHNOLOGIES
29
+ PRIVATE LIMITED EXPRESSLY DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT
30
+ NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
31
+ NON-INFRINGEMENT.
32
+
33
+ 4. LIMITATION OF LIABILITY
34
+ IN NO EVENT SHALL SOLITON TECHNOLOGIES PRIVATE LIMITED BE LIABLE FOR ANY INDIRECT,
35
+ INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF OR RELATED TO THE USE OF
36
+ THIS SUPPLEMENT.
37
+
38
+ 5. CONFIDENTIALITY
39
+ This Supplement constitutes confidential and proprietary information of Soliton
40
+ Technologies Private Limited. You shall not disclose any part of it to third parties
41
+ without prior written consent.
42
+
43
+ 6. TERM AND TERMINATION
44
+ This license is effective until terminated. It terminates automatically upon any breach
45
+ of these terms or upon termination of the EULA. Upon termination, you must immediately
46
+ cease all use and destroy all copies of the Supplement.
47
+
48
+ 7. MISCELLANEOUS
49
+ 7.1. This Supplement shall be governed by and construed in accordance with the same
50
+ governing law and jurisdiction as specified in the EULA.
51
+ 7.2. This Supplement, together with the EULA, constitutes the entire agreement between
52
+ the parties with respect to the Supplement and supersedes all prior agreements
53
+ relating thereto.
@@ -0,0 +1,116 @@
1
+ Metadata-Version: 2.4
2
+ Name: protocol-validation-suite-framework-apis
3
+ Version: 26.7.1
4
+ Summary: A robust Protocol Validation Suite for generating, parsing, and validating protocol messages and conformance tests across protocol implementations.
5
+ License: Proprietary
6
+ License-File: LICENSE
7
+ Author: Soliton Technologies
8
+ Requires-Python: >=3.12
9
+ Classifier: License :: Other/Proprietary License
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3.12
12
+ Classifier: Programming Language :: Python :: 3.13
13
+ Classifier: Programming Language :: Python :: 3.14
14
+ Requires-Dist: grpcio (>=1.81.1)
15
+ Requires-Dist: protobuf (>=6.33.5)
16
+ Description-Content-Type: text/markdown
17
+
18
+ # Soliton Protocol Validation Suite Framework APIs
19
+
20
+ A Python SDK for automating the Soliton Protocol Validation Suite (PVS).
21
+
22
+ This package provides a high-level Python interface for interacting with the "Soliton Protocol Validation Suite" application. It enables Integration of PVS workflows such as profile configuration, sequence compilation, and test execution workflows into custom Python-based automation frameworks.
23
+
24
+ ## Features
25
+
26
+ * Launch and manage the PVS server
27
+ * Load and configure PVS projects
28
+ * Apply protocol validation profiles
29
+ * Configure and reset interposer boards (if supported by the active protocol plugin)
30
+ * Manage test condition files
31
+ * Compile validation sequences
32
+ * Execute validation sequences and retrieve reports
33
+
34
+ ## Pre-requisite
35
+
36
+ * Protocol Validation Suite (PVS) application Installed. (If not please reach out to `pvs.support@solitontech.com`)
37
+ * Python 3.12 or later
38
+
39
+ ## Python Dependencies Requirement
40
+
41
+ * grpcio
42
+ * protobuf
43
+
44
+ ## Installation
45
+
46
+ ```bash
47
+ pip install protocol-validation-suite-framework-apis
48
+ ```
49
+ ## Package Contents
50
+
51
+ The package includes:
52
+
53
+ * High-level PVS API wrappers
54
+ * gRPC client implementation
55
+ * Generated Protocol Buffer stubs
56
+ * Request and response models
57
+ * Example automation scripts
58
+
59
+ ## Notes
60
+
61
+ * This package acts as a Python client SDK for the Protocol Validation Suite application. The actual Validation logic is executed by the PVS server.
62
+ * This package communicates with the server using gRPC and Protocol Buffers.
63
+
64
+ ## Main API Operations
65
+
66
+ | Method | Description |
67
+ | -------------------------- | ------------------------------------ |
68
+ | `launch_server()` | Start and connect to the PVS server |
69
+ | `close_server()` | Close the server connection |
70
+ | `load_project()` | Load a PVS project |
71
+ | `set_profile()` | Apply a protocol validation profile |
72
+ | `setup_interposer_board()` | Configure interposer board settings (Can only be used if the protocol plugin supports it) |
73
+ | `reset_interposer_board()` | Reset interposer board configuration (Can only be used if the protocol plugin supports it) |
74
+ | `set_test_condition()` | Configure test condition files |
75
+ | `compile_sequence()` | Compile a validation sequence |
76
+ | `run_sequence()` | Execute a validation sequence |
77
+ | `mass_compile_sequence()` | Compile multiple sequences |
78
+
79
+ ## Quick Start
80
+
81
+ ```python
82
+ from Protocol_Validation_Suite_APIs.protocol_validation_suite_apis import (
83
+ ProtocolValidationSuiteAPIs
84
+ )
85
+
86
+ api = ProtocolValidationSuiteAPIs()
87
+
88
+ if api.launch_server():
89
+ api.load_project(
90
+ r"C:\Path\To\Project\Sample_Project.pvsproj"
91
+ )
92
+
93
+ # Perform required operations
94
+
95
+ api.close_server()
96
+ ```
97
+
98
+ ## Typical Workflow
99
+
100
+ 1. Launch the PVS server
101
+ 2. Load a PVS project
102
+ 3. Apply a validation profile
103
+ 4. Configure hardware and test conditions
104
+ 5. Compile a validation sequence
105
+ 6. Execute the sequence
106
+ 7. Retrieve reports and results
107
+ 8. Close the server connection
108
+
109
+ ## License
110
+
111
+ **Proprietary**
112
+
113
+ Copyright © Soliton Technologies.
114
+
115
+ Redistribution, modification, or distribution of this package without prior authorization is prohibited.
116
+