imswitchclient 0.1.0__tar.gz → 0.1.2__tar.gz

imswitchclient-0.1.2/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.1
+Name: imswitchclient
+Version: 0.1.2
+Summary: This is a package that connects ImSwitch's REST API to the rest of the world (e.g. jupyter lab)
+Home-page: https://github.com/beniroquai/imswitchclient
+Author: Benedict Diederich
+Author-email: benedictdied@gmail.com
+License: MIT license
+Keywords: imswitchclient
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.rst
+
+# ImSwitchClient Documentation
+
+`ImSwitchClient` is a Python package designed to connect to the ImSwitch REST API, enabling remote control of ImSwitchUC2 functionalities directly from Jupyter Notebooks. This client facilitates easy integration with the ImSwitch ecosystem, offering programmable access to various features like laser control, stage manipulation, and image acquisition.
+
+[![PyPI Version](https://img.shields.io/pypi/v/imswitchclient.svg)](https://pypi.python.org/pypi/imswitchclient)
+
+## Features
+
+- **Remote Control**: Interact with ImSwitchUC2 from Jupyter Notebooks via fastapi endpoints.
+- **Comprehensive Documentation**: Access detailed documentation and explore API endpoints at [https://imswitchclient.readthedocs.io](https://imswitchclient.readthedocs.io).
+- **API Exploration**: Utilize FastAPI's interface at http://localhost:8000/docs for an interactive API experience.
+- **Broad Functionality**: Current implementations include laser control, stage manipulation, and image acquisition, with the possibility for future expansion based on user requests.
+- **Global API Testing**: Test the client using the globally hosted API at [https://youseetoo.github.io/imswitch/api.html](https://youseetoo.github.io/imswitch/api.html).
+- **Open Source**: Inspired by the OpenFlexure Client, `ImSwitchClient` is freely available for modification and distribution under the MIT license.
+- **Implemented functions** (so far, please file an issue for feature requests):
+  - Laser
+  - Stage
+  - Image Acquisition
+- You can test the client with the globally hosted api here: https://youseetoo.github.io/imswitch/api.html
+- It is inspired by the OpenFlexure Client: https://gitlab.com/openflexure/openflexure-microscope-pyclient/-/blob/master/openflexure_microscope_client/microscope_client.py
+- The source files can be found here: https://github.com/openUC2/imswitchclient/
+
+## Installation
+
+To install `ImSwitchClient`, use the following pip command:
+
+```bash
+pip install imswitchclient
+```
+
+## Quick Start Example
+
+This example demonstrates basic usage of `ImSwitchClient` for moving a positioner and acquiring an image.
+
+```python
+import imswitchclient.ImSwitchClient as imc 
+import numpy as np
+import matplotlib.pyplot as plt
+import time
+
+# Initialize the client
+client = imc.ImSwitchClient()
+
+# Retrieve the first positioner's name and current position
+positioner_names = client.positionersManager.getAllDeviceNames()
+positioner_name = positioner_names[0]
+currentPositions = client.positionersManager.getPositionerPositions()[positioner_name]
+initialPosition = (currentPositions["X"], currentPositions["Y"])
+
+# turn on illumination
+mLaserName = client.lasersManager.getLaserNames()[0]
+client.lasersManager.setLaserActive(mLaserName, True)
+client.lasersManager.setLaserValue(mLaserName, 512)
+
+for ix in range(10):
+    for iy in range(10):
+        # Define and move to a new position
+        newPosition = (initialPosition[0] + ix*50, initialPosition[1] + iy*50)
+        client.positionersManager.movePositioner(positioner_name, "X", newPosition[0], is_absolute=True, is_blocking=True)
+        client.positionersManager.movePositioner(positioner_name, "Y", newPosition[1], is_absolute=True, is_blocking=True)
+        
+        # Acquire and display an image
+        #time.sleep(0.5)  # Allow time for the move
+        lastFrame = client.recordingManager.snapNumpyToFastAPI()
+        plt.imshow(lastFrame)
+        plt.show()
+        
+        # Return the positioner to its initial position
+        client.positionersManager.movePositioner(positioner_name, "X", initialPosition[0], is_absolute=True, is_blocking=True)
+        client.positionersManager.movePositioner(positioner_name, "Y", initialPosition[1], is_absolute=True, is_blocking=True)
+```
+
+## Contributing
+
+Contributions to `ImSwitchClient` are welcome! Please refer to the project's GitHub repository for contribution guidelines: [https://github.com/openUC2/imswitchclient/](https://github.com/openUC2/imswitchclient/).
+
+## License
+
+`ImSwitchClient` is licensed under the MIT License. For more details, see the LICENSE file in the project repository.
+

imswitchclient-0.1.2/README.md

@@ -0,0 +1,80 @@
+# ImSwitchClient Documentation
+
+`ImSwitchClient` is a Python package designed to connect to the ImSwitch REST API, enabling remote control of ImSwitchUC2 functionalities directly from Jupyter Notebooks. This client facilitates easy integration with the ImSwitch ecosystem, offering programmable access to various features like laser control, stage manipulation, and image acquisition.
+
+[![PyPI Version](https://img.shields.io/pypi/v/imswitchclient.svg)](https://pypi.python.org/pypi/imswitchclient)
+
+## Features
+
+- **Remote Control**: Interact with ImSwitchUC2 from Jupyter Notebooks via fastapi endpoints.
+- **Comprehensive Documentation**: Access detailed documentation and explore API endpoints at [https://imswitchclient.readthedocs.io](https://imswitchclient.readthedocs.io).
+- **API Exploration**: Utilize FastAPI's interface at http://localhost:8000/docs for an interactive API experience.
+- **Broad Functionality**: Current implementations include laser control, stage manipulation, and image acquisition, with the possibility for future expansion based on user requests.
+- **Global API Testing**: Test the client using the globally hosted API at [https://youseetoo.github.io/imswitch/api.html](https://youseetoo.github.io/imswitch/api.html).
+- **Open Source**: Inspired by the OpenFlexure Client, `ImSwitchClient` is freely available for modification and distribution under the MIT license.
+- **Implemented functions** (so far, please file an issue for feature requests):
+  - Laser
+  - Stage
+  - Image Acquisition
+- You can test the client with the globally hosted api here: https://youseetoo.github.io/imswitch/api.html
+- It is inspired by the OpenFlexure Client: https://gitlab.com/openflexure/openflexure-microscope-pyclient/-/blob/master/openflexure_microscope_client/microscope_client.py
+- The source files can be found here: https://github.com/openUC2/imswitchclient/
+
+## Installation
+
+To install `ImSwitchClient`, use the following pip command:
+
+```bash
+pip install imswitchclient
+```
+
+## Quick Start Example
+
+This example demonstrates basic usage of `ImSwitchClient` for moving a positioner and acquiring an image.
+
+```python
+import imswitchclient.ImSwitchClient as imc 
+import numpy as np
+import matplotlib.pyplot as plt
+import time
+
+# Initialize the client
+client = imc.ImSwitchClient()
+
+# Retrieve the first positioner's name and current position
+positioner_names = client.positionersManager.getAllDeviceNames()
+positioner_name = positioner_names[0]
+currentPositions = client.positionersManager.getPositionerPositions()[positioner_name]
+initialPosition = (currentPositions["X"], currentPositions["Y"])
+
+# turn on illumination
+mLaserName = client.lasersManager.getLaserNames()[0]
+client.lasersManager.setLaserActive(mLaserName, True)
+client.lasersManager.setLaserValue(mLaserName, 512)
+
+for ix in range(10):
+    for iy in range(10):
+        # Define and move to a new position
+        newPosition = (initialPosition[0] + ix*50, initialPosition[1] + iy*50)
+        client.positionersManager.movePositioner(positioner_name, "X", newPosition[0], is_absolute=True, is_blocking=True)
+        client.positionersManager.movePositioner(positioner_name, "Y", newPosition[1], is_absolute=True, is_blocking=True)
+        
+        # Acquire and display an image
+        #time.sleep(0.5)  # Allow time for the move
+        lastFrame = client.recordingManager.snapNumpyToFastAPI()
+        plt.imshow(lastFrame)
+        plt.show()
+        
+        # Return the positioner to its initial position
+        client.positionersManager.movePositioner(positioner_name, "X", initialPosition[0], is_absolute=True, is_blocking=True)
+        client.positionersManager.movePositioner(positioner_name, "Y", initialPosition[1], is_absolute=True, is_blocking=True)
+```
+
+## Contributing
+
+Contributions to `ImSwitchClient` are welcome! Please refer to the project's GitHub repository for contribution guidelines: [https://github.com/openUC2/imswitchclient/](https://github.com/openUC2/imswitchclient/).
+
+## License
+
+`ImSwitchClient` is licensed under the MIT License. For more details, see the LICENSE file in the project repository.
+

imswitchclient-0.1.2/imswitchclient/ImSwitchClient.py

@@ -0,0 +1,53 @@
+import requests
+import json
+import time
+import io
+import PIL.Image
+import numpy as np
+import logging
+import os
+
+from .positionersManager import positionersManager
+from .recordingManager import recordingManager
+from .lasersManager import lasersManager
+
+
+class ImSwitchClient(object):
+    def __init__(self, host="0.0.0.0", isHttps=True, port=8001):
+        self.host = host
+        self.port = port
+        self.isHttps = isHttps
+        self.get_json(self.base_uri+"/openapi.json")
+        
+        logging.info(f"Connecting to microscope {self.host}:{self.port}")
+        
+        # register managers
+        self.positionersManager = positionersManager(self)
+        self.recordingManager = recordingManager(self)
+        self.lasersManager = lasersManager(self)
+        
+    @property
+    def base_uri(self):
+        if self.isHttps:
+            return f"https://{self.host}:{self.port}"
+        else:
+            return f"http://{self.host}:{self.port}"
+
+    def get_json(self, path, payload={}, headers={}):
+        """Perform an HTTP GET request and return the JSON response"""
+        if not path.startswith("http"):
+            path = self.base_uri + path
+        r = requests.get(path, params=payload, headers=headers, verify=False)
+        r.raise_for_status()
+        return r.json()
+
+    def post_json(self, path, payload={}, headers={}, wait_on_task="auto"):
+        """Make an HTTP POST request and return the JSON response"""
+        if not path.startswith("http"):
+            path = self.base_uri + path
+        r = requests.post(path, json=payload, headers=headers, verify=False)
+        r.raise_for_status()
+        r = r.json()
+        return r
+
+

{imswitchclient-0.1.0 → imswitchclient-0.1.2}/imswitchclient/__init__.py

@@ -1,6 +1,6 @@
 """Top-level package for ImSwitchClient."""
-from imswitchclient import ImSwitchClient
+from imswitchclient import *
 
 __author__ = """Benedict Diederich"""
 __email__ = 'benedictdied@gmail.com'
-__version__ = "v0.0.0"#'0.1.0'
+__version__ = "v0.1.2"#'0.1.2'

{imswitchclient-0.1.0 → imswitchclient-0.1.2}/imswitchclient/client.py

@@ -8,6 +8,8 @@ import logging
 import zeroconf
 import os
 
+import urllib3
+urllib3.disable_warnings()
 
 class ImSwitchClient(object):
     def __init__(self, host="localhost", port=8000):

imswitchclient-0.1.2/imswitchclient/lasersManager.py

@@ -0,0 +1,30 @@
+
+class lasersManager(object):
+    
+    def __init__(self, parent):
+        self.parent = parent
+        
+    def getLaserNames(self):
+        url = f"{self.parent.base_uri}/LaserController/getLaserNames"
+        headers = {'accept': 'application/json'}
+
+        response = self.parent.get_json(url, headers=headers)
+        return response
+    
+    def setLaserValue(self, laser_name, value=0):
+        url = f"{self.parent.base_uri}/LaserController/setLaserValue"
+        payload = {
+            'laserName': laser_name,
+            'value': value
+        }
+        response = self.parent.get_json(url, payload=payload)
+        return response
+
+    def setLaserActive(self, laser_name, active=True):
+        url = f"{self.parent.base_uri}/LaserController/setLaserActive"
+        payload = {
+            "laserName": laser_name,
+            "active": active
+        }
+        response = self.parent.get_json(url, payload=payload)
+        return response

imswitchclient-0.1.2/imswitchclient/positionersManager.py

@@ -0,0 +1,53 @@
+
+class positionersManager(object):
+    
+    def __init__(self, parent):
+        self.parent = parent
+        
+    def getAllDeviceNames(self):
+        url = f"{self.parent.base_uri}/PositionerController/getPositionerNames"
+        headers = {'accept': 'application/json'}
+
+        response = self.parent.get_json(url, headers=headers)
+        return response
+    
+    def movePositionerForever(self, speed=(0, 0, 0, 0), is_stop=False):
+        url = f"{self.parent.base_uri}/PositionerController/movePositionerForever"
+        payload = {
+            'speed': speed,
+            'isStop': is_stop
+        }
+        response = self.parent.get_json(url, payload=payload)
+        return response       
+            
+    def setPositionerSpeed(self, positioner_name, axis, speed):
+        url = f"{self.parent.base_uri}/PositionerController/setPositionerSpeed"
+        payload = {
+            'positionerName': positioner_name,
+            'axis': axis,
+            'speed': speed
+        }
+        response = self.parent.get_json(url, payload=payload)
+        return response
+        
+    def movePositioner(self, positioner_name, axis, dist, is_absolute=True, is_blocking=True, speed=10000):
+        url = f"{self.parent.base_uri}/PositionerController/movePositioner"
+        payload = {
+            'positionerName': positioner_name,
+            'axis': axis,
+            'dist': dist,
+            'isAbsolute': is_absolute,
+            'isBlocking': is_blocking, 
+            'speed': speed
+        }
+        #headers = {'accept': 'application/json'}
+
+        response = self.parent.get_json(url, payload=payload)
+        return response
+
+    def getPositionerPositions(self):
+        url = f"{self.parent.base_uri}/PositionerController/getPositionerPositions"
+        payload = {
+        }
+        response = self.parent.get_json(url, payload=payload)
+        return response

imswitchclient-0.1.2/imswitchclient/recordingManager.py

@@ -0,0 +1,28 @@
+
+import requests
+import json
+import numpy as np
+import PIL
+import io
+
+class recordingManager(object):
+    
+    def __init__(self, parent):
+        self.parent = parent
+        
+    def snapNumpyToFastAPI(self, resizeFactor=1):        
+        url = f"{self.parent.base_uri}/RecordingController/snapNumpyToFastAPI"
+        headers = {'accept': 'application/json'}
+        payload ={'resizeFactor':resizeFactor}
+        # we do not use parent's get function here
+        response = requests.get(url, params=payload, headers=headers, verify=False)
+        response.raise_for_status()
+        content_type = response.headers.get('content-type')
+        if content_type == 'image/png':
+            image_data = response.content
+            image = PIL.Image.open(io.BytesIO(image_data))
+            return np.array(image)
+        else:
+            raise ValueError("Unexpected response content-type. Expected 'image/png'.")
+        
+

imswitchclient-0.1.2/imswitchclient.egg-info/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.1
+Name: imswitchclient
+Version: 0.1.2
+Summary: This is a package that connects ImSwitch's REST API to the rest of the world (e.g. jupyter lab)
+Home-page: https://github.com/beniroquai/imswitchclient
+Author: Benedict Diederich
+Author-email: benedictdied@gmail.com
+License: MIT license
+Keywords: imswitchclient
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.rst
+
+# ImSwitchClient Documentation
+
+`ImSwitchClient` is a Python package designed to connect to the ImSwitch REST API, enabling remote control of ImSwitchUC2 functionalities directly from Jupyter Notebooks. This client facilitates easy integration with the ImSwitch ecosystem, offering programmable access to various features like laser control, stage manipulation, and image acquisition.
+
+[![PyPI Version](https://img.shields.io/pypi/v/imswitchclient.svg)](https://pypi.python.org/pypi/imswitchclient)
+
+## Features
+
+- **Remote Control**: Interact with ImSwitchUC2 from Jupyter Notebooks via fastapi endpoints.
+- **Comprehensive Documentation**: Access detailed documentation and explore API endpoints at [https://imswitchclient.readthedocs.io](https://imswitchclient.readthedocs.io).
+- **API Exploration**: Utilize FastAPI's interface at http://localhost:8000/docs for an interactive API experience.
+- **Broad Functionality**: Current implementations include laser control, stage manipulation, and image acquisition, with the possibility for future expansion based on user requests.
+- **Global API Testing**: Test the client using the globally hosted API at [https://youseetoo.github.io/imswitch/api.html](https://youseetoo.github.io/imswitch/api.html).
+- **Open Source**: Inspired by the OpenFlexure Client, `ImSwitchClient` is freely available for modification and distribution under the MIT license.
+- **Implemented functions** (so far, please file an issue for feature requests):
+  - Laser
+  - Stage
+  - Image Acquisition
+- You can test the client with the globally hosted api here: https://youseetoo.github.io/imswitch/api.html
+- It is inspired by the OpenFlexure Client: https://gitlab.com/openflexure/openflexure-microscope-pyclient/-/blob/master/openflexure_microscope_client/microscope_client.py
+- The source files can be found here: https://github.com/openUC2/imswitchclient/
+
+## Installation
+
+To install `ImSwitchClient`, use the following pip command:
+
+```bash
+pip install imswitchclient
+```
+
+## Quick Start Example
+
+This example demonstrates basic usage of `ImSwitchClient` for moving a positioner and acquiring an image.
+
+```python
+import imswitchclient.ImSwitchClient as imc 
+import numpy as np
+import matplotlib.pyplot as plt
+import time
+
+# Initialize the client
+client = imc.ImSwitchClient()
+
+# Retrieve the first positioner's name and current position
+positioner_names = client.positionersManager.getAllDeviceNames()
+positioner_name = positioner_names[0]
+currentPositions = client.positionersManager.getPositionerPositions()[positioner_name]
+initialPosition = (currentPositions["X"], currentPositions["Y"])
+
+# turn on illumination
+mLaserName = client.lasersManager.getLaserNames()[0]
+client.lasersManager.setLaserActive(mLaserName, True)
+client.lasersManager.setLaserValue(mLaserName, 512)
+
+for ix in range(10):
+    for iy in range(10):
+        # Define and move to a new position
+        newPosition = (initialPosition[0] + ix*50, initialPosition[1] + iy*50)
+        client.positionersManager.movePositioner(positioner_name, "X", newPosition[0], is_absolute=True, is_blocking=True)
+        client.positionersManager.movePositioner(positioner_name, "Y", newPosition[1], is_absolute=True, is_blocking=True)
+        
+        # Acquire and display an image
+        #time.sleep(0.5)  # Allow time for the move
+        lastFrame = client.recordingManager.snapNumpyToFastAPI()
+        plt.imshow(lastFrame)
+        plt.show()
+        
+        # Return the positioner to its initial position
+        client.positionersManager.movePositioner(positioner_name, "X", initialPosition[0], is_absolute=True, is_blocking=True)
+        client.positionersManager.movePositioner(positioner_name, "Y", initialPosition[1], is_absolute=True, is_blocking=True)
+```
+
+## Contributing
+
+Contributions to `ImSwitchClient` are welcome! Please refer to the project's GitHub repository for contribution guidelines: [https://github.com/openUC2/imswitchclient/](https://github.com/openUC2/imswitchclient/).
+
+## License
+
+`ImSwitchClient` is licensed under the MIT License. For more details, see the LICENSE file in the project repository.
+

{imswitchclient-0.1.0 → imswitchclient-0.1.2}/imswitchclient.egg-info/SOURCES.txt

@@ -3,7 +3,7 @@ CONTRIBUTING.rst
 HISTORY.rst
 LICENSE
 MANIFEST.in
-README.rst
+README.md
 setup.cfg
 setup.py
 docs/Makefile
@@ -19,6 +19,9 @@ docs/usage.rst
 imswitchclient/ImSwitchClient.py
 imswitchclient/__init__.py
 imswitchclient/client.py
+imswitchclient/lasersManager.py
+imswitchclient/positionersManager.py
+imswitchclient/recordingManager.py
 imswitchclient.egg-info/PKG-INFO
 imswitchclient.egg-info/SOURCES.txt
 imswitchclient.egg-info/dependency_links.txt

{imswitchclient-0.1.0 → imswitchclient-0.1.2}/setup.cfg

@@ -8,8 +8,8 @@ search = version='{current_version}'
 replace = version='{new_version}'
 
 [bumpversion:file:imswitchclient/__init__.py]
-search = __version__ = "v0.0.0"#'{current_version}'
-replace = __version__ = "v0.0.0"#'{new_version}'
+search = __version__ = "v0.1.2"#'{current_version}'
+replace = __version__ = "v0.1.2"#'{new_version}'
 
 [bdist_wheel]
 universal = 1

{imswitchclient-0.1.0 → imswitchclient-0.1.2}/setup.py

@@ -4,11 +4,11 @@
 
 from setuptools import setup, find_packages
 
-with open('README.rst') as readme_file:
+with open('README.md') as readme_file:
     readme = readme_file.read()
 
-with open('HISTORY.rst') as history_file:
-    history = history_file.read()
+with open("HISTORY.rst", "r") as fh:
+    history = fh.read()
 
 requirements = [ ]
 
@@ -31,7 +31,8 @@ setup(
     description="This is a package that connects ImSwitch's REST API to the rest of the world (e.g. jupyter lab)",
     install_requires=requirements,
     license="MIT license",
-    long_description=readme + '\n\n' + history,
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
     include_package_data=True,
     keywords='imswitchclient',
     name='imswitchclient',
@@ -39,6 +40,6 @@ setup(
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/beniroquai/imswitchclient',
-    version='0.1.0',
+    version='0.1.2',
     zip_safe=False,
 )

imswitchclient-0.1.0/PKG-INFO

@@ -1,72 +0,0 @@
-Metadata-Version: 2.1
-Name: imswitchclient
-Version: 0.1.0
-Summary: This is a package that connects ImSwitch's REST API to the rest of the world (e.g. jupyter lab)
-Home-page: https://github.com/beniroquai/imswitchclient
-Author: Benedict Diederich
-Author-email: benedictdied@gmail.com
-License: MIT license
-Keywords: imswitchclient
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Requires-Python: >=3.6
-License-File: LICENSE
-License-File: AUTHORS.rst
-
-==============
-ImSwitchClient
-==============
-
-
-.. image:: https://img.shields.io/pypi/v/imswitchclient.svg
-        :target: https://pypi.python.org/pypi/imswitchclient
-
-.. image:: https://img.shields.io/travis/beniroquai/imswitchclient.svg
-        :target: https://travis-ci.com/beniroquai/imswitchclient
-
-.. image:: https://readthedocs.org/projects/imswitchclient/badge/?version=latest
-        :target: https://imswitchclient.readthedocs.io/en/latest/?version=latest
-        :alt: Documentation Status
-
-
-.. image:: https://pyup.io/repos/github/beniroquai/imswitchclient/shield.svg
-     :target: https://pyup.io/repos/github/beniroquai/imswitchclient/
-     :alt: Updates
-
-
-
-This is a package that connects ImSwitch's REST API to the rest of the world (e.g. jupyter lab)
-
-
-* Free software: MIT license
-* Documentation: https://imswitchclient.readthedocs.io.
-
-
-Features
---------
-
-* TODO
-
-Credits
--------
-
-This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
-
-.. _Cookiecutter: https://github.com/audreyr/cookiecutter
-.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
-
-
-=======
-History
-=======
-
-0.1.0 (2023-07-03)
-------------------
-
-* First release on PyPI.

imswitchclient-0.1.0/README.rst

@@ -1,41 +0,0 @@
-==============
-ImSwitchClient
-==============
-
-
-.. image:: https://img.shields.io/pypi/v/imswitchclient.svg
-        :target: https://pypi.python.org/pypi/imswitchclient
-
-.. image:: https://img.shields.io/travis/beniroquai/imswitchclient.svg
-        :target: https://travis-ci.com/beniroquai/imswitchclient
-
-.. image:: https://readthedocs.org/projects/imswitchclient/badge/?version=latest
-        :target: https://imswitchclient.readthedocs.io/en/latest/?version=latest
-        :alt: Documentation Status
-
-
-.. image:: https://pyup.io/repos/github/beniroquai/imswitchclient/shield.svg
-     :target: https://pyup.io/repos/github/beniroquai/imswitchclient/
-     :alt: Updates
-
-
-
-This is a package that connects ImSwitch's REST API to the rest of the world (e.g. jupyter lab)
-
-
-* Free software: MIT license
-* Documentation: https://imswitchclient.readthedocs.io.
-
-
-Features
---------
-
-* TODO
-
-Credits
--------
-
-This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
-
-.. _Cookiecutter: https://github.com/audreyr/cookiecutter
-.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

imswitchclient-0.1.0/imswitchclient/ImSwitchClient.py

@@ -1,105 +0,0 @@
-import requests
-import json
-import time
-import io
-import PIL.Image
-import numpy as np
-import logging
-import zeroconf
-import os
-
-
-class ImSwitchClient(object):
-    def __init__(self, host="localhost", port=8000):
-        self.host = host
-        self.port = port
-        self.get_json(self.base_uri+"/openapi.json")
-        logging.info(f"Connecting to microscope {self.host}:{self.port}")
-        
-    @property
-    def base_uri(self):
-        return f"http://{self.host}:{self.port}"
-
-    def get_json(self, path, payload={}, headers={}):
-        """Perform an HTTP GET request and return the JSON response"""
-        if not path.startswith("http"):
-            path = self.base_uri + path
-        r = requests.get(path, params=payload, headers=headers)
-        r.raise_for_status()
-        return r.json()
-
-    def post_json(self, path, payload={}, headers={}, wait_on_task="auto"):
-        """Make an HTTP POST request and return the JSON response"""
-        if not path.startswith("http"):
-            path = self.base_uri + path
-        r = requests.post(path, json=payload, headers=headers)
-        r.raise_for_status()
-        r = r.json()
-        return r
-
-    def move_positioner(self, positioner_name, axis, dist, is_absolute=True, is_blocking=True):
-        url = f"{self.base_uri}/PositionerController/movePositioner"
-        payload = {
-            'positionerName': positioner_name,
-            'axis': axis,
-            'dist': dist,
-            'isAbsolute': is_absolute,
-            'isBlocking': is_blocking
-        }
-        #headers = {'accept': 'application/json'}
-
-        response = self.get_json(url, payload=payload)
-        return response
-
-    def snap_numpy_to_fastapi(self):
-        url = f"{self.base_uri}/RecordingController/snapNumpyToFastAPI"
-        headers = {'accept': 'application/json'}
-
-        response = requests.get(url, headers=headers)
-        response.raise_for_status()
-        content_type = response.headers.get('content-type')
-        if content_type == 'image/png':
-            image_data = response.content
-            image = PIL.Image.open(io.BytesIO(image_data))
-            return np.array(image)
-        else:
-            raise ValueError("Unexpected response content-type. Expected 'image/png'.")
-        
-    def get_positioner_names(self):
-        url = f"{self.base_uri}/PositionerController/getPositionerNames"
-        headers = {'accept': 'application/json'}
-
-        response = self.get_json(url, headers=headers)
-        return response
-    
-
-
-def task_href(t):
-    """Extract the endpoint address from a task dictionary"""
-    return t["links"]["self"]["href"]
-
-def is_a_task(t):
-    """Return true if a parsed JSON return value represents a task"""
-    self_href = task_href(t)
-    try:
-        return ("/api/v2/tasks/" in self_href or "/api/v2/actions/" in self_href)
-    except:
-        return False
-
-def poll_task(task):
-    """Poll a task until it finishes, and return the return value"""
-    assert is_a_task(task), ("poll_task must be called with a "
-                "parsed JSON representation of a task")
-    log_n = 0
-    while task["status"] in ACTION_RUNNING_KEYWORDS:
-        r = requests.get(task_href(task))
-        r.raise_for_status()
-        task = r.json()
-        while len(task["log"]) > log_n:
-            d = task["log"][log_n]
-            logging.log(d["levelno"], d["message"])
-            log_n += 1
-    for output_key in ACTION_OUTPUT_KEYS:
-        if output_key in task:
-            return task[output_key]
-    return None

imswitchclient-0.1.0/imswitchclient.egg-info/PKG-INFO

@@ -1,72 +0,0 @@
-Metadata-Version: 2.1
-Name: imswitchclient
-Version: 0.1.0
-Summary: This is a package that connects ImSwitch's REST API to the rest of the world (e.g. jupyter lab)
-Home-page: https://github.com/beniroquai/imswitchclient
-Author: Benedict Diederich
-Author-email: benedictdied@gmail.com
-License: MIT license
-Keywords: imswitchclient
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Requires-Python: >=3.6
-License-File: LICENSE
-License-File: AUTHORS.rst
-
-==============
-ImSwitchClient
-==============
-
-
-.. image:: https://img.shields.io/pypi/v/imswitchclient.svg
-        :target: https://pypi.python.org/pypi/imswitchclient
-
-.. image:: https://img.shields.io/travis/beniroquai/imswitchclient.svg
-        :target: https://travis-ci.com/beniroquai/imswitchclient
-
-.. image:: https://readthedocs.org/projects/imswitchclient/badge/?version=latest
-        :target: https://imswitchclient.readthedocs.io/en/latest/?version=latest
-        :alt: Documentation Status
-
-
-.. image:: https://pyup.io/repos/github/beniroquai/imswitchclient/shield.svg
-     :target: https://pyup.io/repos/github/beniroquai/imswitchclient/
-     :alt: Updates
-
-
-
-This is a package that connects ImSwitch's REST API to the rest of the world (e.g. jupyter lab)
-
-
-* Free software: MIT license
-* Documentation: https://imswitchclient.readthedocs.io.
-
-
-Features
---------
-
-* TODO
-
-Credits
--------
-
-This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
-
-.. _Cookiecutter: https://github.com/audreyr/cookiecutter
-.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
-
-
-=======
-History
-=======
-
-0.1.0 (2023-07-03)
-------------------
-
-* First release on PyPI.