BDPotentiometer 0.3.0__tar.gz → 0.4.0__tar.gz

{bdpotentiometer-0.3.0/src/BDPotentiometer.egg-info → bdpotentiometer-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BDPotentiometer
-Version: 0.3.0
+Version: 0.4.0
 Summary: BD Digital Potentiometer
 Author-email: Anton Bondarenko <bond.anton@gmail.com>
 License: MIT License
@@ -36,18 +36,18 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: scietex.hal.spi<1.0.0,>=0.1.0
 Provides-Extra: gpiozero
-Requires-Dist: gpiozero>=1.6.2; extra == "gpiozero"
+Requires-Dist: scietex.hal.spi[gpiozero]; extra == "gpiozero"
 Provides-Extra: spi
-Requires-Dist: spidev>=3.6; extra == "spi"
+Requires-Dist: scietex.hal.spi[spi]; extra == "spi"
 Provides-Extra: dev
-Requires-Dist: gpiozero>=1.6.2; extra == "dev"
-Requires-Dist: spidev>=3.6; extra == "dev"
+Requires-Dist: scietex.hal.spi[gpiozero,spi]; extra == "dev"
 Requires-Dist: numpy; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
-Requires-Dist: gpiozero>=1.6.2; extra == "docs"
+Requires-Dist: scietex.hal.spi[gpiozero]; extra == "docs"
 Requires-Dist: numpy; extra == "docs"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
@@ -75,14 +75,15 @@ The bare package installs the core library only: the model classes and
 $ pip install BDPotentiometer
 ```
 
-The default hardware backend is spidev; the `spi` extra installs it:
+The default hardware backend is spidev; the transport package's `spi` extra
+installs it:
 ```shell
-$ pip install 'BDPotentiometer[spi]'
+$ pip install 'scietex.hal.spi[spi]'
 ```
 
 The optional gpiozero backend needs its own extra:
 ```shell
-$ pip install 'BDPotentiometer[gpiozero]'
+$ pip install 'scietex.hal.spi[gpiozero]'
 ```
 
 ## Usage
@@ -111,20 +112,22 @@ or `spi=`; doing so raises `TypeError`.
 
 ## Transports
 
-SPI access goes through a transport object passed with `transport=`:
+The transport layer lives in the `scietex.hal.spi` distribution
+(https://github.com/bond-anton/scietex.hal.spi). SPI access goes through a
+transport object passed with `transport=`:
 
 * `SpiDevTransport` (default) opens `/dev/spidev<bus>.<device>` through
-  `spidev`; needs the `spi` extra. `port=` maps to the bus, `device=` to the
-  chip-select line.
+  `spidev`; needs `scietex.hal.spi[spi]`. `port=` maps to the bus, `device=` to
+  the chip-select line.
 * `GpiozeroSpiTransport` (optional) wraps gpiozero hardware SPI; passing
   `clock_pin=`, `mosi_pin=`, `miso_pin=`, or `select_pin=` builds one, and it
-  needs the `gpiozero` extra.
+  needs `scietex.hal.spi[gpiozero]`.
 * `FakeSpiTransport` replays scripted responses, so code can run without
   hardware or extras.
 
 ```python
 from BDPotentiometer.mcp4xxx import MCP4231
-from BDPotentiometer.transport import SpiDevTransport
+from scietex.hal.spi import SpiDevTransport
 
 
 my_pot = MCP4231(r_ab=10e3, transport=SpiDevTransport(bus=0, device=0))
@@ -133,7 +136,8 @@ my_pot = MCP4231(r_ab=10e3, transport=SpiDevTransport(bus=0, device=0))
 For tests, the fake backend needs no extra:
 
 ```python
-from BDPotentiometer.transport import FakeSpiTransport
+from BDPotentiometer.mcp4xxx import MCP4231
+from scietex.hal.spi import FakeSpiTransport
 
 
 my_pot = MCP4231(r_ab=10e3, transport=FakeSpiTransport(default=[0, 0]))
@@ -144,10 +148,46 @@ my_pot = MCP4231(r_ab=10e3, transport=FakeSpiTransport(default=[0, 0]))
 `spidev.SpiDev` or a gpiozero SPI object), and `.close()` / `.closed` release
 and report the underlying transport.
 
-`from BDPotentiometer import *` follows `__all__`, which includes
-`GpiozeroSpiTransport`. That name is resolved lazily, so a star import without
-the `gpiozero` extra raises `AttributeError`; import the names you need
-explicitly when the optional backend may be absent.
+Transports are owned by whoever constructs them: a device closes only a
+transport it built itself from backend keywords, and leaves a transport passed
+with `transport=` or `spi=` open.
+
+`from BDPotentiometer import *` follows `__all__`, which lists only the model
+classes: `DigitalPotentiometerDevice`, `DigitalWiper`, `Potentiometer`, and
+`SpiDigitalWiper`. Import transports and transport exceptions from
+`scietex.hal.spi`.
+
+## Upgrading to 0.4.0
+
+0.4.0 moves the transport layer out of this package into the published
+`scietex.hal.spi` 0.1.0 distribution.
+
+Breaking changes:
+
+* `BDPotentiometer.transport` is gone; `scietex.hal.spi` replaces it.
+* These names are no longer importable from `BDPotentiometer`: `SpiTransport`,
+  `SpiDevTransport`, `FakeSpiTransport`, `I2cTransport`, `TransportError`,
+  `TransportClosed`, `is_spi_transport`, `fix_gpiozero_dual_cs_spi`, and
+  `GpiozeroSpiTransport`.
+* `__all__` now lists only `DigitalPotentiometerDevice`, `DigitalWiper`,
+  `Potentiometer`, and `SpiDigitalWiper`.
+* The `ImportError` for a missing backend now names `scietex.hal.spi[spi]` or
+  `scietex.hal.spi[gpiozero]` instead of the `BDPotentiometer` extras.
+
+Migration:
+
+```python
+# before
+from BDPotentiometer.transport import SpiDevTransport
+
+# after
+from scietex.hal.spi import SpiDevTransport
+```
+
+Install the matching transport extra, for example
+`pip install 'scietex.hal.spi[spi]'`. Device constructors, the
+`transport=`/`spi=`/pin keywords, `.close()`, `.closed`, `.transport`, and
+`.spi` are unchanged.
 
 Please see the [examples](examples) directory for more usage examples.
 

{bdpotentiometer-0.3.0 → bdpotentiometer-0.4.0}/README.md

@@ -16,14 +16,15 @@ The bare package installs the core library only: the model classes and
 $ pip install BDPotentiometer
 ```
 
-The default hardware backend is spidev; the `spi` extra installs it:
+The default hardware backend is spidev; the transport package's `spi` extra
+installs it:
 ```shell
-$ pip install 'BDPotentiometer[spi]'
+$ pip install 'scietex.hal.spi[spi]'
 ```
 
 The optional gpiozero backend needs its own extra:
 ```shell
-$ pip install 'BDPotentiometer[gpiozero]'
+$ pip install 'scietex.hal.spi[gpiozero]'
 ```
 
 ## Usage
@@ -52,20 +53,22 @@ or `spi=`; doing so raises `TypeError`.
 
 ## Transports
 
-SPI access goes through a transport object passed with `transport=`:
+The transport layer lives in the `scietex.hal.spi` distribution
+(https://github.com/bond-anton/scietex.hal.spi). SPI access goes through a
+transport object passed with `transport=`:
 
 * `SpiDevTransport` (default) opens `/dev/spidev<bus>.<device>` through
-  `spidev`; needs the `spi` extra. `port=` maps to the bus, `device=` to the
-  chip-select line.
+  `spidev`; needs `scietex.hal.spi[spi]`. `port=` maps to the bus, `device=` to
+  the chip-select line.
 * `GpiozeroSpiTransport` (optional) wraps gpiozero hardware SPI; passing
   `clock_pin=`, `mosi_pin=`, `miso_pin=`, or `select_pin=` builds one, and it
-  needs the `gpiozero` extra.
+  needs `scietex.hal.spi[gpiozero]`.
 * `FakeSpiTransport` replays scripted responses, so code can run without
   hardware or extras.
 
 ```python
 from BDPotentiometer.mcp4xxx import MCP4231
-from BDPotentiometer.transport import SpiDevTransport
+from scietex.hal.spi import SpiDevTransport
 
 
 my_pot = MCP4231(r_ab=10e3, transport=SpiDevTransport(bus=0, device=0))
@@ -74,7 +77,8 @@ my_pot = MCP4231(r_ab=10e3, transport=SpiDevTransport(bus=0, device=0))
 For tests, the fake backend needs no extra:
 
 ```python
-from BDPotentiometer.transport import FakeSpiTransport
+from BDPotentiometer.mcp4xxx import MCP4231
+from scietex.hal.spi import FakeSpiTransport
 
 
 my_pot = MCP4231(r_ab=10e3, transport=FakeSpiTransport(default=[0, 0]))
@@ -85,10 +89,46 @@ my_pot = MCP4231(r_ab=10e3, transport=FakeSpiTransport(default=[0, 0]))
 `spidev.SpiDev` or a gpiozero SPI object), and `.close()` / `.closed` release
 and report the underlying transport.
 
-`from BDPotentiometer import *` follows `__all__`, which includes
-`GpiozeroSpiTransport`. That name is resolved lazily, so a star import without
-the `gpiozero` extra raises `AttributeError`; import the names you need
-explicitly when the optional backend may be absent.
+Transports are owned by whoever constructs them: a device closes only a
+transport it built itself from backend keywords, and leaves a transport passed
+with `transport=` or `spi=` open.
+
+`from BDPotentiometer import *` follows `__all__`, which lists only the model
+classes: `DigitalPotentiometerDevice`, `DigitalWiper`, `Potentiometer`, and
+`SpiDigitalWiper`. Import transports and transport exceptions from
+`scietex.hal.spi`.
+
+## Upgrading to 0.4.0
+
+0.4.0 moves the transport layer out of this package into the published
+`scietex.hal.spi` 0.1.0 distribution.
+
+Breaking changes:
+
+* `BDPotentiometer.transport` is gone; `scietex.hal.spi` replaces it.
+* These names are no longer importable from `BDPotentiometer`: `SpiTransport`,
+  `SpiDevTransport`, `FakeSpiTransport`, `I2cTransport`, `TransportError`,
+  `TransportClosed`, `is_spi_transport`, `fix_gpiozero_dual_cs_spi`, and
+  `GpiozeroSpiTransport`.
+* `__all__` now lists only `DigitalPotentiometerDevice`, `DigitalWiper`,
+  `Potentiometer`, and `SpiDigitalWiper`.
+* The `ImportError` for a missing backend now names `scietex.hal.spi[spi]` or
+  `scietex.hal.spi[gpiozero]` instead of the `BDPotentiometer` extras.
+
+Migration:
+
+```python
+# before
+from BDPotentiometer.transport import SpiDevTransport
+
+# after
+from scietex.hal.spi import SpiDevTransport
+```
+
+Install the matching transport extra, for example
+`pip install 'scietex.hal.spi[spi]'`. Device constructors, the
+`transport=`/`spi=`/pin keywords, `.close()`, `.closed`, `.transport`, and
+`.spi` are unchanged.
 
 Please see the [examples](examples) directory for more usage examples.
 

{bdpotentiometer-0.3.0 → bdpotentiometer-0.4.0}/pyproject.toml

@@ -20,7 +20,7 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 requires-python = ">=3.10"
-dependencies = []
+dependencies = ["scietex.hal.spi >= 0.1.0, < 1.0.0"]
 
 [project.urls]
 "Homepage" = "https://github.com/bond-anton/BDPotentiometer"
@@ -28,10 +28,10 @@ dependencies = []
 "Documentation" = "https://bdpotentiometer.readthedocs.io"
 
 [project.optional-dependencies]
-gpiozero = ["gpiozero>=1.6.2"]
-spi = ["spidev>=3.6"]
-dev = ["gpiozero>=1.6.2", "spidev>=3.6", "numpy"]
-docs = ["sphinx", "sphinx_rtd_theme", "gpiozero>=1.6.2", "numpy"]
+gpiozero = ["scietex.hal.spi[gpiozero]"]
+spi = ["scietex.hal.spi[spi]"]
+dev = ["scietex.hal.spi[spi,gpiozero]", "numpy"]
+docs = ["sphinx", "sphinx_rtd_theme", "scietex.hal.spi[gpiozero]", "numpy"]
 test = ["pytest", "numpy"]
 lint = ["ruff==0.17.4", "ty==0.0.99"]
 

bdpotentiometer-0.4.0/src/BDPotentiometer/__init__.py

@@ -0,0 +1,15 @@
+"""Digital potentiometer and wiper models with pluggable bus transports."""
+
+__version__ = "0.4.0"
+
+
+from .digital_potentiometer import DigitalPotentiometerDevice
+from .digital_wiper import DigitalWiper, SpiDigitalWiper
+from .potentiometer import Potentiometer
+
+__all__ = [
+    "DigitalPotentiometerDevice",
+    "DigitalWiper",
+    "Potentiometer",
+    "SpiDigitalWiper",
+]

{bdpotentiometer-0.3.0 → bdpotentiometer-0.4.0}/src/BDPotentiometer/digital_wiper.py

@@ -3,6 +3,8 @@
 from copy import deepcopy
 from typing import cast
 
+from scietex.hal.spi import SpiTransport, is_spi_transport
+
 from .__helpers import (
     check_bool,
     check_integer,
@@ -12,7 +14,6 @@ from .__helpers import (
 )
 from .__logger import get_logger
 from .potentiometer import Potentiometer
-from .transport.base import SpiTransport, is_spi_transport
 
 
 class DigitalWiper:

{bdpotentiometer-0.3.0 → bdpotentiometer-0.4.0}/src/BDPotentiometer/mcp4xxx/mcp4xx1.py

@@ -2,9 +2,10 @@
 
 from typing import Any
 
+from scietex.hal.spi import SpiTransport
+
 from .. import DigitalPotentiometerDevice
 from ..__helpers import check_integer
-from ..transport.base import SpiTransport
 from .mcp4xxx import MCP4xxx, MCP4xxxPotentiometer, MCP4xxxWiper
 
 

{bdpotentiometer-0.3.0 → bdpotentiometer-0.4.0}/src/BDPotentiometer/mcp4xxx/mcp4xx2.py

@@ -2,9 +2,10 @@
 
 from typing import Any
 
+from scietex.hal.spi import SpiTransport
+
 from .. import DigitalPotentiometerDevice
 from ..__helpers import check_integer
-from ..transport.base import SpiTransport
 from .mcp4xxx import MCP4xxx, MCP4xxxPotentiometer, MCP4xxxWiper
 
 

{bdpotentiometer-0.3.0 → bdpotentiometer-0.4.0}/src/BDPotentiometer/mcp4xxx/mcp4xxx.py

@@ -3,10 +3,15 @@
 from contextlib import suppress
 from typing import Any
 
+from scietex.hal.spi import (
+    GPIOZERO_SPI_ARGS,
+    SpiTransport,
+    build_default_transport,
+    is_spi_transport,
+)
+
 from .. import Potentiometer, SpiDigitalWiper
 from ..__helpers import check_bool, check_integer, clamp
-from ..transport.base import SpiTransport, is_spi_transport
-from ..transport.selection import GPIOZERO_SPI_ARGS, build_default_transport
 
 #: Supported `r_ab` values in ohms for MCP4XXX devices.
 resistance_list: tuple[float, ...] = (5e3, 10e3, 50e3, 100e3)

{bdpotentiometer-0.3.0 → bdpotentiometer-0.4.0/src/BDPotentiometer.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BDPotentiometer
-Version: 0.3.0
+Version: 0.4.0
 Summary: BD Digital Potentiometer
 Author-email: Anton Bondarenko <bond.anton@gmail.com>
 License: MIT License
@@ -36,18 +36,18 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: scietex.hal.spi<1.0.0,>=0.1.0
 Provides-Extra: gpiozero
-Requires-Dist: gpiozero>=1.6.2; extra == "gpiozero"
+Requires-Dist: scietex.hal.spi[gpiozero]; extra == "gpiozero"
 Provides-Extra: spi
-Requires-Dist: spidev>=3.6; extra == "spi"
+Requires-Dist: scietex.hal.spi[spi]; extra == "spi"
 Provides-Extra: dev
-Requires-Dist: gpiozero>=1.6.2; extra == "dev"
-Requires-Dist: spidev>=3.6; extra == "dev"
+Requires-Dist: scietex.hal.spi[gpiozero,spi]; extra == "dev"
 Requires-Dist: numpy; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
-Requires-Dist: gpiozero>=1.6.2; extra == "docs"
+Requires-Dist: scietex.hal.spi[gpiozero]; extra == "docs"
 Requires-Dist: numpy; extra == "docs"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
@@ -75,14 +75,15 @@ The bare package installs the core library only: the model classes and
 $ pip install BDPotentiometer
 ```
 
-The default hardware backend is spidev; the `spi` extra installs it:
+The default hardware backend is spidev; the transport package's `spi` extra
+installs it:
 ```shell
-$ pip install 'BDPotentiometer[spi]'
+$ pip install 'scietex.hal.spi[spi]'
 ```
 
 The optional gpiozero backend needs its own extra:
 ```shell
-$ pip install 'BDPotentiometer[gpiozero]'
+$ pip install 'scietex.hal.spi[gpiozero]'
 ```
 
 ## Usage
@@ -111,20 +112,22 @@ or `spi=`; doing so raises `TypeError`.
 
 ## Transports
 
-SPI access goes through a transport object passed with `transport=`:
+The transport layer lives in the `scietex.hal.spi` distribution
+(https://github.com/bond-anton/scietex.hal.spi). SPI access goes through a
+transport object passed with `transport=`:
 
 * `SpiDevTransport` (default) opens `/dev/spidev<bus>.<device>` through
-  `spidev`; needs the `spi` extra. `port=` maps to the bus, `device=` to the
-  chip-select line.
+  `spidev`; needs `scietex.hal.spi[spi]`. `port=` maps to the bus, `device=` to
+  the chip-select line.
 * `GpiozeroSpiTransport` (optional) wraps gpiozero hardware SPI; passing
   `clock_pin=`, `mosi_pin=`, `miso_pin=`, or `select_pin=` builds one, and it
-  needs the `gpiozero` extra.
+  needs `scietex.hal.spi[gpiozero]`.
 * `FakeSpiTransport` replays scripted responses, so code can run without
   hardware or extras.
 
 ```python
 from BDPotentiometer.mcp4xxx import MCP4231
-from BDPotentiometer.transport import SpiDevTransport
+from scietex.hal.spi import SpiDevTransport
 
 
 my_pot = MCP4231(r_ab=10e3, transport=SpiDevTransport(bus=0, device=0))
@@ -133,7 +136,8 @@ my_pot = MCP4231(r_ab=10e3, transport=SpiDevTransport(bus=0, device=0))
 For tests, the fake backend needs no extra:
 
 ```python
-from BDPotentiometer.transport import FakeSpiTransport
+from BDPotentiometer.mcp4xxx import MCP4231
+from scietex.hal.spi import FakeSpiTransport
 
 
 my_pot = MCP4231(r_ab=10e3, transport=FakeSpiTransport(default=[0, 0]))
@@ -144,10 +148,46 @@ my_pot = MCP4231(r_ab=10e3, transport=FakeSpiTransport(default=[0, 0]))
 `spidev.SpiDev` or a gpiozero SPI object), and `.close()` / `.closed` release
 and report the underlying transport.
 
-`from BDPotentiometer import *` follows `__all__`, which includes
-`GpiozeroSpiTransport`. That name is resolved lazily, so a star import without
-the `gpiozero` extra raises `AttributeError`; import the names you need
-explicitly when the optional backend may be absent.
+Transports are owned by whoever constructs them: a device closes only a
+transport it built itself from backend keywords, and leaves a transport passed
+with `transport=` or `spi=` open.
+
+`from BDPotentiometer import *` follows `__all__`, which lists only the model
+classes: `DigitalPotentiometerDevice`, `DigitalWiper`, `Potentiometer`, and
+`SpiDigitalWiper`. Import transports and transport exceptions from
+`scietex.hal.spi`.
+
+## Upgrading to 0.4.0
+
+0.4.0 moves the transport layer out of this package into the published
+`scietex.hal.spi` 0.1.0 distribution.
+
+Breaking changes:
+
+* `BDPotentiometer.transport` is gone; `scietex.hal.spi` replaces it.
+* These names are no longer importable from `BDPotentiometer`: `SpiTransport`,
+  `SpiDevTransport`, `FakeSpiTransport`, `I2cTransport`, `TransportError`,
+  `TransportClosed`, `is_spi_transport`, `fix_gpiozero_dual_cs_spi`, and
+  `GpiozeroSpiTransport`.
+* `__all__` now lists only `DigitalPotentiometerDevice`, `DigitalWiper`,
+  `Potentiometer`, and `SpiDigitalWiper`.
+* The `ImportError` for a missing backend now names `scietex.hal.spi[spi]` or
+  `scietex.hal.spi[gpiozero]` instead of the `BDPotentiometer` extras.
+
+Migration:
+
+```python
+# before
+from BDPotentiometer.transport import SpiDevTransport
+
+# after
+from scietex.hal.spi import SpiDevTransport
+```
+
+Install the matching transport extra, for example
+`pip install 'scietex.hal.spi[spi]'`. Device constructors, the
+`transport=`/`spi=`/pin keywords, `.close()`, `.closed`, `.transport`, and
+`.spi` are unchanged.
 
 Please see the [examples](examples) directory for more usage examples.
 

{bdpotentiometer-0.3.0 → bdpotentiometer-0.4.0}/src/BDPotentiometer.egg-info/SOURCES.txt

@@ -1,7 +1,6 @@
 LICENSE
 README.md
 pyproject.toml
-src/BDPotentiometer/__gpiozero_helpers.py
 src/BDPotentiometer/__helpers.py
 src/BDPotentiometer/__init__.py
 src/BDPotentiometer/__logger.py
@@ -18,14 +17,7 @@ src/BDPotentiometer/mcp4xxx/__init__.py
 src/BDPotentiometer/mcp4xxx/mcp4xx1.py
 src/BDPotentiometer/mcp4xxx/mcp4xx2.py
 src/BDPotentiometer/mcp4xxx/mcp4xxx.py
-src/BDPotentiometer/transport/__init__.py
-src/BDPotentiometer/transport/base.py
-src/BDPotentiometer/transport/fake.py
-src/BDPotentiometer/transport/gpiozero_spi.py
-src/BDPotentiometer/transport/selection.py
-src/BDPotentiometer/transport/spidev_spi.py
 tests/test_backward_compatibility.py
-tests/test_gpiozero_helpers.py
 tests/test_logger.py
 tests/test_optional_backends.py
 tests/test_version.py

bdpotentiometer-0.4.0/src/BDPotentiometer.egg-info/requires.txt

@@ -0,0 +1,25 @@
+scietex.hal.spi<1.0.0,>=0.1.0
+
+[dev]
+scietex.hal.spi[gpiozero,spi]
+numpy
+
+[docs]
+sphinx
+sphinx_rtd_theme
+scietex.hal.spi[gpiozero]
+numpy
+
+[gpiozero]
+scietex.hal.spi[gpiozero]
+
+[lint]
+ruff==0.17.4
+ty==0.0.99
+
+[spi]
+scietex.hal.spi[spi]
+
+[test]
+pytest
+numpy