syndesi 0.4.1__tar.gz → 0.4.4__tar.gz

syndesi-0.4.4/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: syndesi
+Version: 0.4.4
+Summary: Syndesi
+Author-email: Sébastien Deriaz <sebastien.deriaz1@gmail.com>
+License: GPL
+Keywords: python,syndesi,interface,ethernet,serial,visa
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: prompt_toolkit
+Requires-Dist: pyserial
+Requires-Dist: rich
+Requires-Dist: platformdirs
+Dynamic: license-file
+
+# Syndesi Python Implementation
+
+Syndesi description is available [here](https://github.com/syndesi-project/Syndesi/README.md)
+
+Syndesi is a modular Python framework designed to streamline communication and control of a wide range of electronic instruments and devices. By providing a unified abstraction layer for adapters, protocols, and device drivers, Syndesi enables seamless integration with test equipment such as multimeters, oscilloscopes, power supplies, UART/USB devices, and more. Its flexible architecture supports both high-level and low-level operations, making it ideal for automation, data acquisition, and custom device interfacing in laboratory, industrial, and research environments.
+
+## Installation
+
+The syndesi Python package can be installed through pip
+
+``pip install syndesi``
+
+The package can also be installed locally by cloning this repository
+
+```bash
+git clone https://github.com/syndesi-project/Syndesi
+cd Syndesi
+pip install .
+```
+
+## Usage
+
+The user can work with any of the three following layers :
+
+- Adapters : low-level communication (IP, UART, ...)
+- Protocols : Encapsulated protocols (Delimited, Modbus, ...)
+- Drivers : Device or application specific commands
+
+### Adapters
+
+The adapter allows the user to read and write raw data through IP, serial and VISA
+
+```python
+from syndesi import IP
+
+my_adapter = IP('192.168.1.12', port=5025)
+
+my_adapter.write(b'ping\n')
+
+my_adapter.read() # -> b'pong'
+```
+
+```python
+from syndesi import SerialPort
+
+arduino = SerialPort('/dev/ttyUSB0', baudrate=115200) # COMx on Windows
+arduino.query(b'get_temperature\n') # -> 20.5
+```
+
+### Protocols
+
+Protocols encapsulate and format data
+
+```python
+from syndesi import IP, Delimited
+
+my_server = Delimited(IP('test.server.local', port=1234))
+
+my_server.query('Hello world\n') # -> Hello world (\n is removed by Delimited)
+
+```
+
+### Drivers
+
+A driver only requires an adapter, the protocol (if used) is instanciated internally
+
+```python
+from syndesi_drivers.instruments.mutlimeters.siglent.SDM3055 import SDM3055
+from syndesi.adapters import IP
+
+mm = SDM3055(IP("192.168.1.123"))
+
+voltage = mm.measure_dc_voltage()
+```

syndesi-0.4.4/README.md

@@ -0,0 +1,74 @@
+# Syndesi Python Implementation
+
+Syndesi description is available [here](https://github.com/syndesi-project/Syndesi/README.md)
+
+Syndesi is a modular Python framework designed to streamline communication and control of a wide range of electronic instruments and devices. By providing a unified abstraction layer for adapters, protocols, and device drivers, Syndesi enables seamless integration with test equipment such as multimeters, oscilloscopes, power supplies, UART/USB devices, and more. Its flexible architecture supports both high-level and low-level operations, making it ideal for automation, data acquisition, and custom device interfacing in laboratory, industrial, and research environments.
+
+## Installation
+
+The syndesi Python package can be installed through pip
+
+``pip install syndesi``
+
+The package can also be installed locally by cloning this repository
+
+```bash
+git clone https://github.com/syndesi-project/Syndesi
+cd Syndesi
+pip install .
+```
+
+## Usage
+
+The user can work with any of the three following layers :
+
+- Adapters : low-level communication (IP, UART, ...)
+- Protocols : Encapsulated protocols (Delimited, Modbus, ...)
+- Drivers : Device or application specific commands
+
+### Adapters
+
+The adapter allows the user to read and write raw data through IP, serial and VISA
+
+```python
+from syndesi import IP
+
+my_adapter = IP('192.168.1.12', port=5025)
+
+my_adapter.write(b'ping\n')
+
+my_adapter.read() # -> b'pong'
+```
+
+```python
+from syndesi import SerialPort
+
+arduino = SerialPort('/dev/ttyUSB0', baudrate=115200) # COMx on Windows
+arduino.query(b'get_temperature\n') # -> 20.5
+```
+
+### Protocols
+
+Protocols encapsulate and format data
+
+```python
+from syndesi import IP, Delimited
+
+my_server = Delimited(IP('test.server.local', port=1234))
+
+my_server.query('Hello world\n') # -> Hello world (\n is removed by Delimited)
+
+```
+
+### Drivers
+
+A driver only requires an adapter, the protocol (if used) is instanciated internally
+
+```python
+from syndesi_drivers.instruments.mutlimeters.siglent.SDM3055 import SDM3055
+from syndesi.adapters import IP
+
+mm = SDM3055(IP("192.168.1.123"))
+
+voltage = mm.measure_dc_voltage()
+```

{syndesi-0.4.1 → syndesi-0.4.4}/pyproject.toml

@@ -11,7 +11,7 @@ dynamic = ["version"]
 description = "Syndesi"
 readme = "README.md"
 requires-python = ">=3.10"
-license = { text = "GPL" }  # update if different
+license = { text = "GPL" }
 authors = [{ name = "Sébastien Deriaz", email = "sebastien.deriaz1@gmail.com" }]
 keywords = ["python", "syndesi", "interface", "ethernet", "serial", "visa"]
 classifiers = [
@@ -42,8 +42,6 @@ include = ["syndesi*"]
 [tool.ruff]
 target-version = "py311"
 line-length = 100
-select = ["D","E","F","I","B"]   # include pydocstyle rules ("D")
-#ignore = ["D203","D213"]         # pick your preferences
 
 [tool.ruff.lint]
 select = ["E", "F", "W", "I", "UP", "B"]
@@ -71,3 +69,9 @@ exclude = ["^tests/fixtures/"]
 skips = ["B101"]
 exclude = ["tests"]
 
+[tool.pylint]
+# Disable too-many-arguments, this is the case for adapters/protocols/drivers
+# All arguments are necessary and it would not make sense to group them / move them
+# too-many-positional-arguments is kept however because it makes sense
+# Also disable W1203 to allow f-strings in logging lines
+disable = ["R0913", "W1203"]

{syndesi-0.4.1 → syndesi-0.4.4}/syndesi/__init__.py

@@ -1,5 +1,10 @@
+"""
+Syndesi module
+"""
+
 from .adapters.ip import IP
 from .adapters.serialport import SerialPort
+from .adapters.timeout import Timeout
 from .adapters.visa import Visa
 from .protocols.delimited import Delimited
 from .protocols.modbus import Modbus
@@ -7,4 +12,14 @@ from .protocols.raw import Raw
 from .protocols.scpi import SCPI
 from .tools.log import log
 
-__all__ = ["IP", "SerialPort", "Visa", "Delimited", "Modbus", "Raw", "SCPI", "log"]
+__all__ = [
+    "IP",
+    "SerialPort",
+    "Visa",
+    "Delimited",
+    "Modbus",
+    "Raw",
+    "SCPI",
+    "log",
+    "Timeout",
+]