lima2.client 4.0.0a9__tar.gz → 4.0.dev1__tar.gz

lima2_client-4.0.dev1/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: lima2-client
+Version: 4.0.dev1
+Summary: Python client library for Lima2 detector
+Author: BCU (ESRF)
+License: Copyright (c) 2020-2024 Beamline Control Unit, ESRF
+        
+        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.
+        
+Project-URL: Repository, https://gitlab.esrf.fr/limagroup/lima2-client
+Project-URL: Documentation, https://limagroup.gitlab-pages.esrf.fr/lima2-client/
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: h5py
+Requires-Dist: jsonschema
+Requires-Dist: jsonschema-default
+Requires-Dist: numpy
+Requires-Dist: pytango
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: starlette
+Requires-Dist: typing-extensions
+Requires-Dist: typer
+Requires-Dist: uvicorn[standard]
+Provides-Extra: dev
+Requires-Dist: black==22.3; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: httpx; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: nosqltangodb; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: requests-mock; extra == "dev"
+Requires-Dist: termcolor; extra == "dev"
+Requires-Dist: types-jsonschema; extra == "dev"
+Requires-Dist: types-pyyaml; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: recommonmark; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinxcontrib-mermaid; extra == "docs"
+Requires-Dist: sphinxcontrib-napoleon; extra == "docs"
+Requires-Dist: sphinx-immaterial; extra == "docs"
+Dynamic: license-file
+
+# LImA 2 Client library
+
+This project provides a Python interface to the LImA 2 distributed system.
+
+Checkout the [documentation here](https://limagroup.gitlab-pages.esrf.fr/lima2-client/).
+
+### Development setup
+
+In order to install lima2-client in a new conda environment:
+
+```sh
+conda create -n l2c -c esrf-bcu python==3.10
+pip install .[dev]
+```
+
+The `dev` extra dependency adds linting, formatting, static analysis and testing tools.
+It also installs `ipython` required to run the `lima2_shell`.
+
+### Quickstart with blissdemo
+
+With `bliss-demo-servers` running, you can run an interactive Lima2 client shell to manipulate the
+Lima2 simulator devices and test the client API:
+
+```sh
+export TANGO_HOST="localhost:10000"  # Assuming you are running bliss-demo-servers locally
+lima2_shell
+```
+
+The `lima2_shell` utility instantiates a `Client` object using config from `l2c_config.yaml`,
+creates a set of default control, acquisition and processing parameters, and starts an ipython session.
+
+### Bootstrapping the documentation
+
+The source for the documentation is in the `docs` folder. Here are the instructions to built and read it locally. The documentation is built with [Doxygen](http://www.doxygen.org/) and [Sphinx](http://www.sphinx-doc.org). The sphinx template is from [Sphinx Material](https://bashtage.github.io/sphinx-material/).
+
+```
+    conda create -n doc --file docs/requirements.txt -c conda-forge
+    conda activate doc
+    cd docs
+    make html
+```
+
+The html documentation is generated in `docs/.build/html`.

lima2_client-4.0.dev1/README.md

@@ -0,0 +1,43 @@
+# LImA 2 Client library
+
+This project provides a Python interface to the LImA 2 distributed system.
+
+Checkout the [documentation here](https://limagroup.gitlab-pages.esrf.fr/lima2-client/).
+
+### Development setup
+
+In order to install lima2-client in a new conda environment:
+
+```sh
+conda create -n l2c -c esrf-bcu python==3.10
+pip install .[dev]
+```
+
+The `dev` extra dependency adds linting, formatting, static analysis and testing tools.
+It also installs `ipython` required to run the `lima2_shell`.
+
+### Quickstart with blissdemo
+
+With `bliss-demo-servers` running, you can run an interactive Lima2 client shell to manipulate the
+Lima2 simulator devices and test the client API:
+
+```sh
+export TANGO_HOST="localhost:10000"  # Assuming you are running bliss-demo-servers locally
+lima2_shell
+```
+
+The `lima2_shell` utility instantiates a `Client` object using config from `l2c_config.yaml`,
+creates a set of default control, acquisition and processing parameters, and starts an ipython session.
+
+### Bootstrapping the documentation
+
+The source for the documentation is in the `docs` folder. Here are the instructions to built and read it locally. The documentation is built with [Doxygen](http://www.doxygen.org/) and [Sphinx](http://www.sphinx-doc.org). The sphinx template is from [Sphinx Material](https://bashtage.github.io/sphinx-material/).
+
+```
+    conda create -n doc --file docs/requirements.txt -c conda-forge
+    conda activate doc
+    cd docs
+    make html
+```
+
+The html documentation is generated in `docs/.build/html`.

{lima2_client-4.0.0a9 → lima2_client-4.0.dev1}/pyproject.toml

@@ -26,9 +26,10 @@ dependencies = [
     "pytango",
     "pyyaml",
     "requests",
-    "termcolor",
+    "starlette",
     "typing-extensions",
     "typer",
+    "uvicorn[standard]",
 ]
 
 [project.urls]
@@ -36,41 +37,37 @@ Repository = "https://gitlab.esrf.fr/limagroup/lima2-client"
 Documentation = "https://limagroup.gitlab-pages.esrf.fr/lima2-client/"
 
 [project.scripts]
-lima2-conductor = "lima2.conductor.webservice.cli:cli [conductor]"
-lima2-shell = "lima2.client.shell:app [dev]"
+lima2-conductor = "lima2.conductor.server.cli:cli"
+lima2-shell = "lima2.conductor.client.shell:app [dev]"
 
 [project.optional-dependencies]
-conductor = ["starlette", "uvicorn[standard]"]
-shell = ["ipython"]
 dev = [
     "black==22.3",
     "flake8",
     "httpx",
-    "lima2-client[conductor]", # required to run unit tests
-    "lima2-client[shell]",     # for convenience
+    "ipython",
     "mypy",
     "nosqltangodb",
     "pytest",
     "pytest-asyncio",
     "pytest-cov",
     "requests-mock",
+    "termcolor",
     "types-jsonschema",
     "types-pyyaml",
     "types-requests",
 ]
 docs = [
-    "mkdocs",
-    "markdown-include",
-    "mkdocs-material",
-    "mkdocstrings[python]",
-    "pygments",
+    "recommonmark",
+    "sphinx",
+    "sphinxcontrib-mermaid",
+    "sphinxcontrib-napoleon",
+    "sphinx-immaterial",
 ]
 
 [tool.mypy]
-packages = ["lima2.client", "lima2.conductor", "lima2.common"]
-plugins = "numpy.typing.mypy_plugin"
+packages = ["lima2.client", "lima2.conductor"]
 mypy_path = "src"
-strict = true
 allow_redefinition = true
 explicit_package_bases = true
 warn_return_any = true
@@ -98,9 +95,9 @@ asyncio_default_fixture_loop_scope = "function"
 [tool.coverage.run]
 # Omit entrypoints in coverage report
 omit = [
-    "src/lima2/client/shell.py",
-    "src/lima2/conductor/webservice/cli.py",
-    "src/lima2/conductor/webservice/main.py",
+    "src/lima2/conductor/client/shell.py",
+    "src/lima2/conductor/server/cli.py",
+    "src/lima2/conductor/server/main.py",
 ]
 
 [tool.coverage.report]

lima2_client-4.0.dev1/src/lima2/client/__init__.py

@@ -0,0 +1,14 @@
+# This file is part of the Lima2 project
+#
+# Copyright (c) 2020-2024 Beamline Control Unit, ESRF
+# Distributed under the MIT licence. See LICENSE for more info.
+
+"""Lima2 client package.
+
+Contains the stateful client for the lima2 acquisition system, with
+tango as the communication protocol.
+"""
+
+from lima2.client.acquisition_system import AcquisitionSystem
+
+__all__ = ["AcquisitionSystem"]