chess-pyspec 1.0.0__tar.gz

chess_pyspec-1.0.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 Cornell University
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

chess_pyspec-1.0.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: chess-pyspec
+Version: 1.0.0
+Summary: Python SPEC modules and tools
+Author-email: Kevin Welsh <kevin.welsh@verdantevolution.com>
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cython>=3.2.3
+Requires-Dist: h5py>=3.0.0
+Requires-Dist: numpy
+Requires-Dist: pyee>=13.0.0
+Provides-Extra: dev
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-autodoc-typehints; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Requires-Dist: python-docs-theme; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-timeout; extra == "test"
+Dynamic: license-file
+
+# Test status badge
+
+![Test](https://github.com/Verdant-Evolution/chess-pyspec/actions/workflows/test.yml/badge.svg)
+
+# PySpec
+
+PySpec is a Python implementation of the [SPEC server and client protocol](https://certif.com/spec_help/server.html), providing tools for remote control, data acquisition, and automation in scientific instrumentation environments. It enables Python-based clients to interact with a SPEC server, control motors, read/write variables, and execute commands or functions remotely.
+
+## Features
+
+-   **Async client-server architecture** for high-performance remote control
+-   **Remote property and function access** (read/write variables, call functions)
+-   **Motor control** and status monitoring
+-   **Output streaming** from server to client
+-   **Associative array and data array support**
+-   **Test mode** for safe experimentation
+
+## Installation
+
+PySpec requires Python 3.9+ and depends on `cython`, `h5py`, `numpy`, and `pyee`.
+
+```bash
+pip install .
+# or for development
+pip install -e .[dev]
+```
+
+## Quick Start
+
+### Connecting as a Client
+
+```python
+import asyncio
+from pyspec.client import Client
+
+async def main():
+    async with Client("127.0.0.1", 6510) as client:
+        # Get a reference to "var/foo" on the server.
+        foo = client.var("foo", int)
+        await foo.set(42)
+        value = await foo.get()
+        print("foo:", value) # foo: 42
+
+        result = await client.call("add", 2, 3)
+        print("add(2, 3):", result)
+
+
+        # Wait for properties to be set to specific values
+        await foo.wait_for(15, timeout=10)
+
+
+asyncio.run(main())
+```
+
+### Motor Control Example
+
+```python
+async with Client("127.0.0.1", 6510) as client:
+    motor = client.motor("theta")
+
+    # Read and write motor properties and parameters
+    await motor.sign.get()
+    await motor.offset.get()
+    await motor.position.get()
+    ...
+
+    # Move motors on the server
+    async with motor:
+        await motor.move(10.0)
+        pos = await motor.position.get()
+        print("Motor position:", pos) # "Motor position: 10.0"
+```
+
+### Output Streaming Example
+
+```python
+async with Client("127.0.0.1", 6510) as client:
+    async with client.output("tty").capture() as lines:
+        await client.exec('print("Hello, world!")')
+    print(lines[-1])  # Should print 'Hello, world!\n'
+```
+
+### Starting a Server
+
+```python
+from pyspec.server import Server, Property, remote_function
+import asyncio
+
+class MyServer(Server):
+    foo = Property[int]("foo", 0)
+
+    @remote_function
+    def add(self, a: str, b: str):
+        return float(a) + float(b)
+
+async def main():
+    async with MyServer(host="127.0.0.1", port=6510, test_mode=True) as server:
+        await server.serve_forever()
+
+asyncio.run(main())
+```
+
+Hardware servers currently support properties and remote function calls. Connect with a `PySpec` or `spec` client to interface with a `PySpec` server.
+
+Currently unsupported server features:
+
+1. Associative Arrays
+2. Motor Protocols (through `../start_one` or `../start_all` )
+
+## Testing
+
+Run the test suite with:
+
+```bash
+pytest
+```
+
+## Documentation
+
+See the [docs/](docs/) directory for full API documentation and usage details.
+
+## License
+
+See LICENSE or the source headers for license details. Portions copyright Certified Scientific Software.

chess_pyspec-1.0.0/README.md

@@ -0,0 +1,124 @@
+# Test status badge
+
+![Test](https://github.com/Verdant-Evolution/chess-pyspec/actions/workflows/test.yml/badge.svg)
+
+# PySpec
+
+PySpec is a Python implementation of the [SPEC server and client protocol](https://certif.com/spec_help/server.html), providing tools for remote control, data acquisition, and automation in scientific instrumentation environments. It enables Python-based clients to interact with a SPEC server, control motors, read/write variables, and execute commands or functions remotely.
+
+## Features
+
+-   **Async client-server architecture** for high-performance remote control
+-   **Remote property and function access** (read/write variables, call functions)
+-   **Motor control** and status monitoring
+-   **Output streaming** from server to client
+-   **Associative array and data array support**
+-   **Test mode** for safe experimentation
+
+## Installation
+
+PySpec requires Python 3.9+ and depends on `cython`, `h5py`, `numpy`, and `pyee`.
+
+```bash
+pip install .
+# or for development
+pip install -e .[dev]
+```
+
+## Quick Start
+
+### Connecting as a Client
+
+```python
+import asyncio
+from pyspec.client import Client
+
+async def main():
+    async with Client("127.0.0.1", 6510) as client:
+        # Get a reference to "var/foo" on the server.
+        foo = client.var("foo", int)
+        await foo.set(42)
+        value = await foo.get()
+        print("foo:", value) # foo: 42
+
+        result = await client.call("add", 2, 3)
+        print("add(2, 3):", result)
+
+
+        # Wait for properties to be set to specific values
+        await foo.wait_for(15, timeout=10)
+
+
+asyncio.run(main())
+```
+
+### Motor Control Example
+
+```python
+async with Client("127.0.0.1", 6510) as client:
+    motor = client.motor("theta")
+
+    # Read and write motor properties and parameters
+    await motor.sign.get()
+    await motor.offset.get()
+    await motor.position.get()
+    ...
+
+    # Move motors on the server
+    async with motor:
+        await motor.move(10.0)
+        pos = await motor.position.get()
+        print("Motor position:", pos) # "Motor position: 10.0"
+```
+
+### Output Streaming Example
+
+```python
+async with Client("127.0.0.1", 6510) as client:
+    async with client.output("tty").capture() as lines:
+        await client.exec('print("Hello, world!")')
+    print(lines[-1])  # Should print 'Hello, world!\n'
+```
+
+### Starting a Server
+
+```python
+from pyspec.server import Server, Property, remote_function
+import asyncio
+
+class MyServer(Server):
+    foo = Property[int]("foo", 0)
+
+    @remote_function
+    def add(self, a: str, b: str):
+        return float(a) + float(b)
+
+async def main():
+    async with MyServer(host="127.0.0.1", port=6510, test_mode=True) as server:
+        await server.serve_forever()
+
+asyncio.run(main())
+```
+
+Hardware servers currently support properties and remote function calls. Connect with a `PySpec` or `spec` client to interface with a `PySpec` server.
+
+Currently unsupported server features:
+
+1. Associative Arrays
+2. Motor Protocols (through `../start_one` or `../start_all` )
+
+## Testing
+
+Run the test suite with:
+
+```bash
+pytest
+```
+
+## Documentation
+
+See the [docs/](docs/) directory for full API documentation and usage details.
+
+## License
+
+See LICENSE or the source headers for license details. Portions copyright Certified Scientific Software.

chess_pyspec-1.0.0/chess_pyspec.egg-info/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: chess-pyspec
+Version: 1.0.0
+Summary: Python SPEC modules and tools
+Author-email: Kevin Welsh <kevin.welsh@verdantevolution.com>
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cython>=3.2.3
+Requires-Dist: h5py>=3.0.0
+Requires-Dist: numpy
+Requires-Dist: pyee>=13.0.0
+Provides-Extra: dev
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-autodoc-typehints; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Requires-Dist: python-docs-theme; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-timeout; extra == "test"
+Dynamic: license-file
+
+# Test status badge
+
+![Test](https://github.com/Verdant-Evolution/chess-pyspec/actions/workflows/test.yml/badge.svg)
+
+# PySpec
+
+PySpec is a Python implementation of the [SPEC server and client protocol](https://certif.com/spec_help/server.html), providing tools for remote control, data acquisition, and automation in scientific instrumentation environments. It enables Python-based clients to interact with a SPEC server, control motors, read/write variables, and execute commands or functions remotely.
+
+## Features
+
+-   **Async client-server architecture** for high-performance remote control
+-   **Remote property and function access** (read/write variables, call functions)
+-   **Motor control** and status monitoring
+-   **Output streaming** from server to client
+-   **Associative array and data array support**
+-   **Test mode** for safe experimentation
+
+## Installation
+
+PySpec requires Python 3.9+ and depends on `cython`, `h5py`, `numpy`, and `pyee`.
+
+```bash
+pip install .
+# or for development
+pip install -e .[dev]
+```
+
+## Quick Start
+
+### Connecting as a Client
+
+```python
+import asyncio
+from pyspec.client import Client
+
+async def main():
+    async with Client("127.0.0.1", 6510) as client:
+        # Get a reference to "var/foo" on the server.
+        foo = client.var("foo", int)
+        await foo.set(42)
+        value = await foo.get()
+        print("foo:", value) # foo: 42
+
+        result = await client.call("add", 2, 3)
+        print("add(2, 3):", result)
+
+
+        # Wait for properties to be set to specific values
+        await foo.wait_for(15, timeout=10)
+
+
+asyncio.run(main())
+```
+
+### Motor Control Example
+
+```python
+async with Client("127.0.0.1", 6510) as client:
+    motor = client.motor("theta")
+
+    # Read and write motor properties and parameters
+    await motor.sign.get()
+    await motor.offset.get()
+    await motor.position.get()
+    ...
+
+    # Move motors on the server
+    async with motor:
+        await motor.move(10.0)
+        pos = await motor.position.get()
+        print("Motor position:", pos) # "Motor position: 10.0"
+```
+
+### Output Streaming Example
+
+```python
+async with Client("127.0.0.1", 6510) as client:
+    async with client.output("tty").capture() as lines:
+        await client.exec('print("Hello, world!")')
+    print(lines[-1])  # Should print 'Hello, world!\n'
+```
+
+### Starting a Server
+
+```python
+from pyspec.server import Server, Property, remote_function
+import asyncio
+
+class MyServer(Server):
+    foo = Property[int]("foo", 0)
+
+    @remote_function
+    def add(self, a: str, b: str):
+        return float(a) + float(b)
+
+async def main():
+    async with MyServer(host="127.0.0.1", port=6510, test_mode=True) as server:
+        await server.serve_forever()
+
+asyncio.run(main())
+```
+
+Hardware servers currently support properties and remote function calls. Connect with a `PySpec` or `spec` client to interface with a `PySpec` server.
+
+Currently unsupported server features:
+
+1. Associative Arrays
+2. Motor Protocols (through `../start_one` or `../start_all` )
+
+## Testing
+
+Run the test suite with:
+
+```bash
+pytest
+```
+
+## Documentation
+
+See the [docs/](docs/) directory for full API documentation and usage details.
+
+## License
+
+See LICENSE or the source headers for license details. Portions copyright Certified Scientific Software.

chess_pyspec-1.0.0/chess_pyspec.egg-info/SOURCES.txt

@@ -0,0 +1,43 @@
+LICENSE
+README.md
+pyproject.toml
+chess_pyspec.egg-info/PKG-INFO
+chess_pyspec.egg-info/SOURCES.txt
+chess_pyspec.egg-info/dependency_links.txt
+chess_pyspec.egg-info/requires.txt
+chess_pyspec.egg-info/top_level.txt
+pyspec/__init__.py
+pyspec/_connection/__init__.py
+pyspec/_connection/associative_array.py
+pyspec/_connection/client_connection.py
+pyspec/_connection/command.py
+pyspec/_connection/connection.py
+pyspec/_connection/data.py
+pyspec/_connection/flag.py
+pyspec/_connection/protocol.py
+pyspec/_connection/server_connection.py
+pyspec/client/__init__.py
+pyspec/client/_motor.py
+pyspec/client/_remote_property_table.py
+pyspec/client/_status.py
+pyspec/client/client.py
+pyspec/file/__init__.py
+pyspec/file/css_logger.py
+pyspec/file/h5datasets.py
+pyspec/file/hamamatsu.py
+pyspec/file/hdf5.py
+pyspec/file/spec.py
+pyspec/server/__init__.py
+pyspec/server/_remote_function.py
+pyspec/server/_remote_property.py
+pyspec/server/server.py
+pyspec/shared_memory/datashm_py.c
+pyspec/shared_memory/spec_shm.h
+pyspec/shared_memory/sps.c
+pyspec/shared_memory/sps.h
+test/test_associative_array.py
+test/test_client.py
+test/test_client_with_spec_server.py
+test/test_protocol.py
+test/test_protocol_version_mismatch.py
+test/test_server.py

chess_pyspec-1.0.0/chess_pyspec.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

chess_pyspec-1.0.0/chess_pyspec.egg-info/requires.txt

@@ -0,0 +1,15 @@
+cython>=3.2.3
+h5py>=3.0.0
+numpy
+pyee>=13.0.0
+
+[dev]
+sphinx
+sphinx-autodoc-typehints
+sphinx-rtd-theme
+python-docs-theme
+
+[test]
+pytest-asyncio
+pytest-cov
+pytest-timeout

chess_pyspec-1.0.0/chess_pyspec.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyspec

chess_pyspec-1.0.0/pyproject.toml

@@ -0,0 +1,47 @@
+[project]
+name = "chess-pyspec"
+version = "1.0.0"
+description = "Python SPEC modules and tools"
+license-files = ["LICENSE"]
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [{ name = "Kevin Welsh", email = "kevin.welsh@verdantevolution.com" }]
+dependencies = ["cython>=3.2.3", "h5py>=3.0.0", "numpy", "pyee>=13.0.0"]
+
+[project.optional-dependencies]
+dev = [
+    "sphinx",
+    "sphinx-autodoc-typehints",
+    "sphinx-rtd-theme",
+    "python-docs-theme"
+]
+test = ["pytest-asyncio", "pytest-cov", "pytest-timeout"]
+
+[tool.setuptools]
+packages = [
+    "pyspec",
+    "pyspec.shared_memory",
+    "pyspec._connection",
+    "pyspec.file",
+    "pyspec.server",
+    "pyspec.client"
+]
+ext-modules = [
+    { name = "pyspec.shared_memory.shared_memory", sources = [
+        "pyspec/shared_memory/datashm_py.c",
+        "pyspec/shared_memory/sps.c",
+    ], include-dirs = ["pyspec/shared_memory"] },
+]
+
+[tool.setuptools.package-data]
+"pyspec.shared_memory" = ["*.h"]
+
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools>=80.9.0", "wheel", "cython"]
+
+[tool.coverage.report]
+omit = ["pyspec/shared_memory/**", "pyspec/file/**"]
+
+[tool.coverage.run]
+patch = ["subprocess"]

chess_pyspec-1.0.0/pyspec/__init__.py

@@ -0,0 +1,14 @@
+from .client import Client, RemoteException
+from .server import Server, Property
+
+from . import shared_memory  # type: ignore
+from . import file
+
+__all__ = [
+    "Client",
+    "RemoteException",
+    "Property",
+    "Server",
+    "shared_memory",
+    "file",
+]

chess_pyspec-1.0.0/pyspec/_connection/__init__.py

@@ -0,0 +1,10 @@
+from .client_connection import ClientConnection
+from .server_connection import ServerConnection
+from .associative_array import AssociativeArrayElement, AssociativeArray
+
+__all__ = [
+    "ClientConnection",
+    "ServerConnection",
+    "AssociativeArray",
+    "AssociativeArrayElement",
+]