indipyterm 0.0.1__tar.gz

indipyterm-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Bernard Czenkusz
+
+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.

indipyterm-0.0.1/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: indipyterm
+Version: 0.0.1
+Summary: A terminal client which can be used to control remote instruments using the INDI protocol.
+Keywords: indi,client,astronomy,instrument
+Author-email: Bernard Czenkusz <bernie@skipole.co.uk>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
+Requires-Dist: indipyclient>=0.6.8
+Requires-Dist: textual>=1.0.0
+Project-URL: Source, https://github.com/bernie-skipole/indipyterm
+
+# indipyterm
+
+You may have Python programs implementing some form of data collection or control and wish to remotely operate such an instrument.
+
+An associated package 'indipydriver' can be used to take your data, organise it into a data structure defined by the INDI protocol, and serve it on a port.
+
+This indipyterm package provides a terminal client, which connects to the port, allowing you to view and control your instrument from a terminal session.
+
+It can be installed from Pypi with:
+
+pip install indipyterm
+
+indipydriver and indipyterm communicate with the INDI protocol.
+
+INDI - Instrument Neutral Distributed Interface.
+
+See https://en.wikipedia.org/wiki/Instrument_Neutral_Distributed_Interface
+
+The client can be run with
+
+indipyterm [options]
+
+or with
+
+python3 -m indipyterm [options]
+
+The package help is:
+
+    usage: indipyterm [options]
+
+    Terminal client to communicate to an INDI service.
+
+    options:
+      -h, --help   show this help message and exit
+      --port PORT  Port of the INDI server (default 7624).
+      --host HOST  Hostname/IP of the INDI server (default localhost).
+      --version    show program's version number and exit
+
+
+A typical session would look like:
+
+![Terminal screenshot](https://github.com/bernie-skipole/indipyterm/raw/main/indipyterm1.png)
+
+and showing one device:
+
+![Terminal screenshot](https://github.com/bernie-skipole/indipyterm/raw/main/indipyterm2.png)
+
+
+The INDI protocol defines the format of the data sent, such as light, number, text, switch or BLOB (Binary Large Object). The client is general purpose, taking the format of switches, numbers etc., from the protocol.
+
+The package can be installed from:
+
+https://pypi.org/project/indipyterm
+
+If installed from Pypi using pip, then dependencies will automatically be pulled and installed, these are:
+
+indipyclient - which generates and parses the INDI protocol.
+
+textual - a library used to generate terminal interfaces.
+
+Plus other packages which textual calls upon.
+
+The indipydriver package which can be used to create instrument control, and serve the INDI protocol is available at:
+
+https://pypi.org/project/indipydriver
+
+https://github.com/bernie-skipole/indipydriver
+
+https://indipydriver.readthedocs.io
+

indipyterm-0.0.1/README.md

@@ -0,0 +1,69 @@
+# indipyterm
+
+You may have Python programs implementing some form of data collection or control and wish to remotely operate such an instrument.
+
+An associated package 'indipydriver' can be used to take your data, organise it into a data structure defined by the INDI protocol, and serve it on a port.
+
+This indipyterm package provides a terminal client, which connects to the port, allowing you to view and control your instrument from a terminal session.
+
+It can be installed from Pypi with:
+
+pip install indipyterm
+
+indipydriver and indipyterm communicate with the INDI protocol.
+
+INDI - Instrument Neutral Distributed Interface.
+
+See https://en.wikipedia.org/wiki/Instrument_Neutral_Distributed_Interface
+
+The client can be run with
+
+indipyterm [options]
+
+or with
+
+python3 -m indipyterm [options]
+
+The package help is:
+
+    usage: indipyterm [options]
+
+    Terminal client to communicate to an INDI service.
+
+    options:
+      -h, --help   show this help message and exit
+      --port PORT  Port of the INDI server (default 7624).
+      --host HOST  Hostname/IP of the INDI server (default localhost).
+      --version    show program's version number and exit
+
+
+A typical session would look like:
+
+![Terminal screenshot](https://github.com/bernie-skipole/indipyterm/raw/main/indipyterm1.png)
+
+and showing one device:
+
+![Terminal screenshot](https://github.com/bernie-skipole/indipyterm/raw/main/indipyterm2.png)
+
+
+The INDI protocol defines the format of the data sent, such as light, number, text, switch or BLOB (Binary Large Object). The client is general purpose, taking the format of switches, numbers etc., from the protocol.
+
+The package can be installed from:
+
+https://pypi.org/project/indipyterm
+
+If installed from Pypi using pip, then dependencies will automatically be pulled and installed, these are:
+
+indipyclient - which generates and parses the INDI protocol.
+
+textual - a library used to generate terminal interfaces.
+
+Plus other packages which textual calls upon.
+
+The indipydriver package which can be used to create instrument control, and serve the INDI protocol is available at:
+
+https://pypi.org/project/indipydriver
+
+https://github.com/bernie-skipole/indipydriver
+
+https://indipydriver.readthedocs.io

indipyterm-0.0.1/indipyterm/__init__.py

@@ -0,0 +1,3 @@
+
+
+version = "0.0.1"

indipyterm-0.0.1/indipyterm/__main__.py

@@ -0,0 +1,32 @@
+
+
+import sys, argparse
+
+from . import version
+from .indipyterm import IPyTerm
+from .connections import make_connection
+
+
+
+def main():
+    """The commandline entry point to run the terminal client."""
+
+    parser = argparse.ArgumentParser(usage="indipyterm [options]",
+                                     description="Terminal client to communicate to an INDI service.")
+    parser.add_argument("--port", type=int, default=7624, help="Port of the INDI server (default 7624).")
+    parser.add_argument("--host", default="localhost", help="Hostname/IP of the INDI server (default localhost).")
+    parser.add_argument("--version", action="version", version=version)
+    args = parser.parse_args()
+
+    # Create the initial server connection
+    make_connection(host=args.host, port=args.port)
+
+    # run the IPyTerm app
+    app = IPyTerm()
+    app.run()
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())