indipyconsole 0.0.1__tar.gz

indipyconsole-0.0.1/LICENSE

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

indipyconsole-0.0.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: indipyconsole
+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
+License-File: LICENSE
+Requires-Dist: indipyclient>=0.8.4
+Project-URL: Source, https://github.com/bernie-skipole/indipyconsole
+
+# indipyconsole
+
+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 indipyconsole package provides a terminal client, which connects to the port, allowing you to view and control your instrument from a terminal session.
+
+A further package indipyterm is also available, by the same author, which you may prefer.
+
+indipyterm can run on other OS's apart from Linux, and gives a more attractive terminal output, however it depends on third party libraries.
+
+indipyconsole only depends on indipyclient - which provides the communication methods. It uses the Python standard library curses package, which is only available on Linux.
+
+The main purpose of indipyconsole is to provide an indipendent client, in case the third party packages used by indipyterm break. It also provides logging capabilities to save communications data to a logfile. The two clients can both connect to an INDI server to compare output.
+
+indipyconsole can be installed from Pypi with:
+
+pip install indipyconsole
+
+or if you use uv, it can be loaded and run with:
+
+uvx indipyconsole
+
+indipydriver and indipyconsole communicate with the INDI protocol.
+
+INDI - Instrument Neutral Distributed Interface.
+
+See https://en.wikipedia.org/wiki/Instrument_Neutral_Distributed_Interface
+
+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 client can be run from a virtual environment with
+
+indipyconsole [options]
+
+or with
+
+python3 -m indipyconsole [options]
+
+The package help is:
+
+    usage: indipyconsole [options]
+
+    Console client to communicate to an INDI service.
+
+    options:
+      -h, --help                show this help message and exit
+      -p PORT, --port PORT      Port of the INDI server (default 7624).
+      --host HOST               Hostname/IP of the INDI server (default localhost).
+      -b BLOBS, --blobs BLOBS   Optional folder where BLOB's will be saved.
+      --loglevel LOGLEVEL       Enables logging, value 1, 2, 3 or 4.
+      --logfile LOGFILE         File where logs will be saved
+      --version                 show program's version number and exit
+
+    The BLOB's folder can also be set from within the session.
+    Setting loglevel and logfile should only be used for brief
+    diagnostic purposes, the logfile could grow very big.
+    loglevel:1 Information and error messages only, no exception trace.
+    The following levels enable exception traces in the logs
+    loglevel:2 As 1 plus xml vector tags without members or contents,
+    loglevel:3 As 1 plus xml vectors and members - but not BLOB contents,
+    loglevel:4 As 1 plus xml vectors and all contents
+
+
+If installed from Pypi, then the dependecy indipyclient will automatically be pulled and installed.
+
+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
+
+With example driver scripts at:
+
+https://github.com/bernie-skipole/inditest
+
+The indipyterm package is available at:
+
+https://pypi.org/project/indipyterm
+
+https://github.com/bernie-skipole/indipyterm
+
+The indipyclient package contains classes which may be useful if you want to create your own client or client script:
+
+https://pypi.org/project/indipyclient
+
+https://github.com/bernie-skipole/indipyclient
+
+https://indipyclient.readthedocs.io
+

indipyconsole-0.0.1/README.md

@@ -0,0 +1,92 @@
+# indipyconsole
+
+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 indipyconsole package provides a terminal client, which connects to the port, allowing you to view and control your instrument from a terminal session.
+
+A further package indipyterm is also available, by the same author, which you may prefer.
+
+indipyterm can run on other OS's apart from Linux, and gives a more attractive terminal output, however it depends on third party libraries.
+
+indipyconsole only depends on indipyclient - which provides the communication methods. It uses the Python standard library curses package, which is only available on Linux.
+
+The main purpose of indipyconsole is to provide an indipendent client, in case the third party packages used by indipyterm break. It also provides logging capabilities to save communications data to a logfile. The two clients can both connect to an INDI server to compare output.
+
+indipyconsole can be installed from Pypi with:
+
+pip install indipyconsole
+
+or if you use uv, it can be loaded and run with:
+
+uvx indipyconsole
+
+indipydriver and indipyconsole communicate with the INDI protocol.
+
+INDI - Instrument Neutral Distributed Interface.
+
+See https://en.wikipedia.org/wiki/Instrument_Neutral_Distributed_Interface
+
+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 client can be run from a virtual environment with
+
+indipyconsole [options]
+
+or with
+
+python3 -m indipyconsole [options]
+
+The package help is:
+
+    usage: indipyconsole [options]
+
+    Console client to communicate to an INDI service.
+
+    options:
+      -h, --help                show this help message and exit
+      -p PORT, --port PORT      Port of the INDI server (default 7624).
+      --host HOST               Hostname/IP of the INDI server (default localhost).
+      -b BLOBS, --blobs BLOBS   Optional folder where BLOB's will be saved.
+      --loglevel LOGLEVEL       Enables logging, value 1, 2, 3 or 4.
+      --logfile LOGFILE         File where logs will be saved
+      --version                 show program's version number and exit
+
+    The BLOB's folder can also be set from within the session.
+    Setting loglevel and logfile should only be used for brief
+    diagnostic purposes, the logfile could grow very big.
+    loglevel:1 Information and error messages only, no exception trace.
+    The following levels enable exception traces in the logs
+    loglevel:2 As 1 plus xml vector tags without members or contents,
+    loglevel:3 As 1 plus xml vectors and members - but not BLOB contents,
+    loglevel:4 As 1 plus xml vectors and all contents
+
+
+If installed from Pypi, then the dependecy indipyclient will automatically be pulled and installed.
+
+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
+
+With example driver scripts at:
+
+https://github.com/bernie-skipole/inditest
+
+The indipyterm package is available at:
+
+https://pypi.org/project/indipyterm
+
+https://github.com/bernie-skipole/indipyterm
+
+The indipyclient package contains classes which may be useful if you want to create your own client or client script:
+
+https://pypi.org/project/indipyclient
+
+https://github.com/bernie-skipole/indipyclient
+
+https://indipyclient.readthedocs.io

indipyconsole-0.0.1/indipyconsole/__init__.py

@@ -0,0 +1,10 @@
+import sys
+
+from .consoleclient import ConsoleClient
+
+__all__ = ["ConsoleClient"]
+
+version = "0.0.1"
+
+if sys.version_info < (3, 10):
+    raise ImportError('indipyconsole requires Python >= 3.10')

indipyconsole-0.0.1/indipyconsole/__main__.py

@@ -0,0 +1,126 @@
+
+"""Creates a terminal client
+
+Try
+
+python3 -m indipyconsole --help
+
+For a description of options
+"""
+
+
+import sys, argparse, asyncio, pathlib, logging
+
+from . import version
+
+from . import ConsoleClient
+
+logger = logging.getLogger()
+
+# logger is the root logger, with level and handler set here
+# by the arguments given. If no logging option is given, it
+# has a NullHandler() added
+
+
+def setlogging(client, level, logfile):
+    """Sets the logging level and logfile, returns the level on success, None on failure.
+       level should be an integer, one of 1, 2, 3 or 4."""
+
+    # loglevel:1 Information and error messages only
+    # loglevel:2 log vector tags without members or contents
+    # loglevel:3 log vectors and members - but not BLOB contents
+    # loglevel:4 log vectors and all contents
+
+    try:
+        if level not in (1, 2, 3, 4):
+            return
+        logfile = pathlib.Path(logfile).expanduser().resolve()
+
+        if level == 4:
+            logger.setLevel(logging.DEBUG)
+            client.debug_verbosity(3)
+        elif level == 3:
+            logger.setLevel(logging.DEBUG)
+            client.debug_verbosity(2)
+        elif level == 2:
+            logger.setLevel(logging.DEBUG)
+            client.debug_verbosity(1)
+        elif level == 1:
+            logger.setLevel(logging.INFO)
+            client.debug_verbosity(0)
+            # If logging debug not enabled, reduce traceback info
+            sys.tracebacklimit = 0
+
+        fh = logging.FileHandler(logfile)
+        logger.addHandler(fh)
+    except Exception:
+        return
+    return level
+
+
+def main():
+    """The commandline entry point to run the terminal client."""
+
+    parser = argparse.ArgumentParser(usage="indipyconsole [options]",
+                                     formatter_class=argparse.RawDescriptionHelpFormatter,
+                                     description="Console client to communicate to an INDI service.",
+                                     epilog="""The BLOB's folder can also be set from within the session.
+Setting loglevel and logfile should only be used for brief
+diagnostic purposes, the logfile could grow very big.
+loglevel:1 Information and error messages only, no exception trace.
+The following levels enable exception traces in the logs
+loglevel:2 As 1 plus xml vector tags without members or contents,
+loglevel:3 As 1 plus xml vectors and members - but not BLOB contents,
+loglevel:4 As 1 plus xml vectors and all contents
+""")
+    parser.add_argument("-p", "--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("-b", "--blobs", help="Optional folder where BLOB's will be saved.")
+    parser.add_argument("--loglevel", help="Enables logging, value 1, 2, 3 or 4.")
+    parser.add_argument("--logfile", help="File where logs will be saved")
+
+    parser.add_argument("--version", action="version", version=version)
+    args = parser.parse_args()
+
+    if args.blobs:
+        try:
+            blobfolder = pathlib.Path(args.blobs).expanduser().resolve()
+        except Exception:
+            print("Error: If given, the BLOB's folder should be an existing directory")
+            return 1
+        else:
+            if not blobfolder.is_dir():
+                print("Error: If given, the BLOB's folder should be an existing directory")
+                return 1
+    else:
+        blobfolder = None
+
+    if args.loglevel:
+        if args.loglevel not in ("1", "2", "3", "4"):
+            print("Error: If given, the loglevel should be 1, 2, 3 or 4")
+            return 1
+
+
+    client = ConsoleClient(indihost=args.host, indiport=args.port, blobfolder=blobfolder)
+
+    if args.loglevel and args.logfile:
+        loglevel = int(args.loglevel)
+        level = setlogging(client, loglevel, args.logfile)
+        if level != loglevel:
+            print("Error: Failed to set logging")
+            return 1
+    else:
+        logger.addHandler(logging.NullHandler())
+
+    try:
+        # Starts the client, creates the console screens
+        asyncio.run(client.asyncrun())
+    finally:
+        # clear curses setup
+        client.console_reset()
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())