Merge pull request #122 from ZLLentz/bld_bundle_script

BLD/MAINT: bundle bin script, make psdaq optional, include tests in dist

.gitignore

@@ -107,3 +107,4 @@ ENV/
 
 # vim
 *.swp
+*.un~

conda-recipe/meta.yaml

@@ -30,6 +30,8 @@ requirements:
 test:
   imports:
   - pcdsdaq
+  commands:
+  - pcdsdaq_lib_setup
   requires:
   - pytest
   - pytest-timeout

docs/source/releases.rst

@@ -1,6 +1,14 @@
 Release History
 ###############
 
+v2.4.2 (2023-04-13)
+===================
+
+- Fix issues related to the missing pcdsdaq_lib_setup script
+- Fix issues related to failing pypi builds
+- Fix issues related to failing docs builds
+
+
 v2.4.1 (2023-04-11)
 ===================
 

pcdsdaq/daq/lcls2.py

@@ -57,14 +57,19 @@
 from ophyd.utils import StatusTimeoutError, WaitTimeoutError
 from ophyd.utils.errors import InvalidState
 from pcdsutils.enum import HelpfulIntEnum
-from psdaq.control.ControlDef import ControlDef
-from psdaq.control.DaqControl import DaqControl
 
 from .interface import (CONFIG_VAL, ControlsArg, DaqBase,
                         DaqStateTransitionError, DaqTimeoutError, EnumId,
                         Sentinel, TernaryBool, get_controls_name,
                         get_controls_value, typing_check)
 
+try:
+    from psdaq.control.ControlDef import ControlDef
+    from psdaq.control.DaqControl import DaqControl
+except ImportError:
+    ControlDef = None
+    DaqControl = None
+
 logger = logging.getLogger(__name__)
 
 
@@ -1811,6 +1816,11 @@ class SimDaqControl:
 
     def __init__(self, *args, **kwargs):
         logger.debug("SimDaqControl.__init__(%s, %s)", args, kwargs)
+        if None in (ControlDef, DaqControl):
+            raise RuntimeError(
+                'Optional dependency psdaq is not installed, '
+                'cannot run lcls2 daq'
+            )
         self._lock = threading.RLock()
         self._new_status = threading.Event()
         self._headers = HelpfulIntEnum(

tests/test_daq_lcls2.py → pcdsdaq/tests/test_daq_lcls2.py

@@ -12,16 +12,22 @@
 from ophyd.signal import Signal
 from ophyd.sim import motor
 from ophyd.utils.errors import WaitTimeoutError
-from psdaq.control.ControlDef import ControlDef
 
 from pcdsdaq.daq import DaqLCLS2, DaqTimeoutError
 from pcdsdaq.daq.interface import DaqStateTransitionError, TernaryBool
 
+try:
+    from psdaq.control.ControlDef import ControlDef
+except ImportError:
+    ControlDef = None
+
 logger = logging.getLogger(__name__)
 
 
 @pytest.fixture(scope='function')
 def daq_lcls2(RE: RunEngine) -> DaqLCLS2:
+    if ControlDef is None:
+        pytest.skip(reason='psdaq is not installed')
     return DaqLCLS2(
         platform=0,
         host='tst',

pyproject.toml

@@ -3,12 +3,13 @@ build-backend = "setuptools.build_meta"
 requires = [ "setuptools>=45", "setuptools_scm[toml]>=6.2",]
 
 [project]
-classifiers = [ "Development Status :: 2 - Pre-Alpha", "Natural Language :: English", "Programming Language :: Python :: 3",]
+classifiers = [ "Development Status :: 5 - Production/Stable", "Natural Language :: English", "Programming Language :: Python :: 3",]
 description = "DAQ Control Interface"
 dynamic = [ "version", "readme", "dependencies", "optional-dependencies", "optional-dependencies",]
 keywords = []
 name = "pcdsdaq"
 requires-python = ">=3.9"
+
 [[project.authors]]
 name = "SLAC National Accelerator Laboratory"
 
@@ -30,6 +31,9 @@ where = [ ".",]
 include = [ "pcdsdaq*",]
 namespaces = false
 
+[tool.setuptools]
+script-files = [ "bin/pcdsdaq_lib_setup",]
+
 [tool.setuptools.dynamic.readme]
 file = "README.rst"