MultiPyVu 3.1.0__tar.gz → 3.1.1__tar.gz

{multipyvu-3.1.0/src/MultiPyVu.egg-info → multipyvu-3.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: MultiPyVu
-Version: 3.1.0
+Version: 3.1.1
 Summary: Control MultiVu using Python
 Author-email: Damon D Jackson <djackson@qdusa.com>
 Maintainer-email: "Quantum Design, Inc." <apps@qdusa.com>
@@ -436,17 +436,24 @@ client = mpv.Client(port=6000)
 - A log file named QdMultiVu.log shows the traffic between the server and client which can also be useful during troubleshooting.
 
 ## Changelog<a class="anchor" id="changelog"></a>
+**3.1.1**
+- October 2024
+- Updated the installer to include missing files.
+
 **3.1.0**
 - October 2024
 - Log the version number when the Client connects to the Server.
 - Check that the Server and Client are running the same version.
 - Increase the number of backup logs to 5.
 - Bugfix to allow Client to run on Linux or Mac systems.
-- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
 - Limit server to hosting only one client at a time.
 - Add the ability to call -quit, -is_running, -status, -get_ip from the command line using python -m MultiPyVu
 - Miscellaneous bug fixes and refactoring.
 
+**2.2.0**
+- January 2024
+- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
+
 **2.1.4**
 - October 2023
 - Import full module as MultiPyVu. Instead of loading the three sub-modules as:

{multipyvu-3.1.0 → multipyvu-3.1.1}/README.md

@@ -390,17 +390,24 @@ client = mpv.Client(port=6000)
 - A log file named QdMultiVu.log shows the traffic between the server and client which can also be useful during troubleshooting.
 
 ## Changelog<a class="anchor" id="changelog"></a>
+**3.1.1**
+- October 2024
+- Updated the installer to include missing files.
+
 **3.1.0**
 - October 2024
 - Log the version number when the Client connects to the Server.
 - Check that the Server and Client are running the same version.
 - Increase the number of backup logs to 5.
 - Bugfix to allow Client to run on Linux or Mac systems.
-- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
 - Limit server to hosting only one client at a time.
 - Add the ability to call -quit, -is_running, -status, -get_ip from the command line using python -m MultiPyVu
 - Miscellaneous bug fixes and refactoring.
 
+**2.2.0**
+- January 2024
+- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
+
 **2.1.4**
 - October 2023
 - Import full module as MultiPyVu. Instead of loading the three sub-modules as:

{multipyvu-3.1.0 → multipyvu-3.1.1}/setup.py

@@ -46,8 +46,9 @@ setup(
             "images/*.jpg",
             "images/*.png",
             "font/*.ttf",
-            "scripts/*.cmd",
-            "MultiVuDataFile/*.py"
+            "scripts/*",
+            "MultiVuDataFile/*.py",
+            "logging_config.yaml"
             ]
         },
     python_requires=">=3.8",

{multipyvu-3.1.0 → multipyvu-3.1.1}/src/MultiPyVu/__version.py

@@ -1,2 +1,2 @@
 # -*- coding: utf-8 -*-
-__version__ = "3.1.0"
+__version__ = "3.1.1"

multipyvu-3.1.1/src/MultiPyVu/logging_config.yaml

@@ -0,0 +1,42 @@
+version: 1
+disable_existing_loggers: True
+formatters:
+  show_name:
+    format: '%(name)s - %(message)s'
+  no_name:
+    format: '%(message)s'
+  debug:
+    format: '%(asctime)-27s %(name)-20s %(levelname)-8s %(message)s'
+  gui:
+    format: '%(asctime)s - %(message)s'
+    datefmt: '%m-%d %H:%M'
+handlers:
+  console:
+    class: logging.StreamHandler
+    level: INFO
+    formatter: show_name
+    stream: ext://sys.stdout
+  file:
+    class: logging.handlers.RotatingFileHandler
+    level: DEBUG
+    formatter: debug
+    filename: debug
+    maxBytes: 4194304  # 2^22
+    backupCount: 5
+loggers:
+  MultiVuServer:
+    level: DEBUG
+    handlers: [console, file]
+    text_widget: text_widget
+    propagate: False
+  MultiVuClient:
+    level: DEBUG
+    handlers: [console, file]
+    propagate: False
+  UnitTest:
+    level: DEBUG
+    handlers: [console, file]
+    propagate: False
+root:
+  level: WARNING
+  handlers: [console]

multipyvu-3.1.1/src/MultiPyVu/scripts/helper_scripts.py

@@ -0,0 +1,118 @@
+"""
+A few helpful scripts used in the MultiPyVu module
+"""
+
+from os import path
+from sys import platform
+import subprocess
+import re
+
+from MultiPyVu.MultiVuClient import Client
+
+
+def absolute_path(filename: str) -> str:
+    """
+    Finds the absolute path of a file based on its location
+    relative to the gui module
+
+    Parameters:
+    -----------
+    filename: str
+        The file location based on its relative path from the gui module
+    """
+    abs_path = path.abspath(
+        path.join(path.dirname(
+            __file__), './'))
+    return path.join(abs_path, filename)
+
+
+def get_ip():
+    """
+    The IP address for the computer
+
+    Returns:
+    --------
+    String with the IP address
+    """
+    ip_output_str = ''
+    search_str = r'([0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3})'
+    if platform == 'win32':
+        ip_addr_script = 'whats_my_ip_address.cmd'
+        ip_addr_script = absolute_path(ip_addr_script)
+        proc = subprocess.run([ip_addr_script],
+                              capture_output=True,
+                              text=True)
+        if proc.returncode != 0:
+            print(proc.stderr)
+            raise Exception(proc.stderr)
+        ip_result = re.findall(search_str, proc.stdout)
+        if len(ip_result) == 1:
+            ip_address = ip_result[0]
+    else:
+        # using this suggestion:
+        # https://apple.stackexchange.com/questions/20547/how-do-i-find-my-ip-address-from-the-command-line
+        ifconfig_proc = subprocess.Popen(["ifconfig"],
+                                         stdout=subprocess.PIPE,
+                                         text=True)
+        grep_proc = subprocess.Popen(["grep", "inet"],
+                                     stdin=ifconfig_proc.stdout,
+                                     stdout=subprocess.PIPE,
+                                     text=True)
+        ip_output_str, err = grep_proc.communicate()
+        if err is not None:
+            print(err)
+            raise Exception(grep_proc.stderr)
+        ip_result = re.findall(search_str, ip_output_str)
+        if '127.0.0.1' in ip_result:
+            ip_result.remove('127.0.0.1')
+        if len(ip_result) >= 1:
+            ip_address = ip_result[0]
+    return ip_address
+
+
+def run_status(ip: str, port: int):
+    """
+    Queries the server for its status.
+    """
+    ip_address = ip
+    if ip_address == '0.0.0.0':
+        ip_address = 'localhost'
+
+    client = Client(host=ip_address,
+                    port=port)
+    response = client.get_server_status()
+    print(f'Server status: {response}')
+
+
+def is_running(ip: str, port: int):
+    """
+    Queries the server to see if it is running
+    """
+    ip_address = ip
+    if ip_address == '0.0.0.0':
+        ip_address = 'localhost'
+
+    client = Client(host=ip_address,
+                    port=port)
+    response = client.is_server_running()
+    if response:
+        print(f'Server is running at {client.address}')
+    else:
+        print(f'Server not running at {client.address}')
+
+
+def force_quit(ip: str, port: int) -> str:
+    """
+    Quits the server.
+    """
+    ip_address = ip
+    if ip_address == '0.0.0.0':
+        ip_address = 'localhost'
+
+    client = Client(host=ip_address,
+                    port=port)
+    response = client.force_quit_server()
+    if response:
+        return response
+    else:
+        return f'Sent quit command to {client.address}'

{multipyvu-3.1.0 → multipyvu-3.1.1/src/MultiPyVu.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: MultiPyVu
-Version: 3.1.0
+Version: 3.1.1
 Summary: Control MultiVu using Python
 Author-email: Damon D Jackson <djackson@qdusa.com>
 Maintainer-email: "Quantum Design, Inc." <apps@qdusa.com>
@@ -436,17 +436,24 @@ client = mpv.Client(port=6000)
 - A log file named QdMultiVu.log shows the traffic between the server and client which can also be useful during troubleshooting.
 
 ## Changelog<a class="anchor" id="changelog"></a>
+**3.1.1**
+- October 2024
+- Updated the installer to include missing files.
+
 **3.1.0**
 - October 2024
 - Log the version number when the Client connects to the Server.
 - Check that the Server and Client are running the same version.
 - Increase the number of backup logs to 5.
 - Bugfix to allow Client to run on Linux or Mac systems.
-- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
 - Limit server to hosting only one client at a time.
 - Add the ability to call -quit, -is_running, -status, -get_ip from the command line using python -m MultiPyVu
 - Miscellaneous bug fixes and refactoring.
 
+**2.2.0**
+- January 2024
+- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
+
 **2.1.4**
 - October 2023
 - Import full module as MultiPyVu. Instead of loading the three sub-modules as:

{multipyvu-3.1.0 → multipyvu-3.1.1}/src/MultiPyVu.egg-info/SOURCES.txt

@@ -28,6 +28,7 @@ src/MultiPyVu/exceptions.py
 src/MultiPyVu/generate_sdo_objects.py
 src/MultiPyVu/instrument.py
 src/MultiPyVu/logging_config.py
+src/MultiPyVu/logging_config.yaml
 src/MultiPyVu/project_vars.py
 src/MultiPyVu/sdo_object.py
 src/MultiPyVu.egg-info/PKG-INFO
@@ -49,4 +50,5 @@ src/MultiPyVu/gui/ViewTk.py
 src/MultiPyVu/gui/__init__.py
 src/MultiPyVu/images/Q.png
 src/MultiPyVu/images/QD_logo.jpg
+src/MultiPyVu/scripts/helper_scripts.py
 src/MultiPyVu/scripts/whats_my_ip_address.cmd