lscom 0.0.2__py3-none-any.whl → 0.0.4__py3-none-any.whl

lscom/__main__.py

@@ -10,9 +10,9 @@ lscom
 list available serial ports
 """
 
+import argparse
 import sys
 
-from lscom import helpers
 from lscom.__version__ import __title__, __version__
 from lscom.app import run
 
@@ -34,7 +34,14 @@ def check_python_version():  # type: ignore
 
 
 def main():
-    parser = helpers.setup_parser()
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description="lscom: list and discover available COM ports",
+        epilog="Made with Python by Josh Schmelzle",
+    )
+    parser.add_argument(
+        "--version", "-v", action="version", version=f"lscom version {__version__}"
+    )
     args = parser.parse_args()  # noqa: F841
     run()
 
@@ -43,8 +50,7 @@ def init():
     check_python_version()  # type: ignore
 
     if __name__ == "__main__":
-        main()
-        sys.exit(0)
+        sys.exit(main())
 
 
 init()

lscom/__version__.py

@@ -3,12 +3,12 @@
 # |  _  _  _  ._ _
 # | _> (_ (_) | | |
 
-""" version information for lscom """
+"""version information for lscom"""
 
 __title__ = "lscom"
 __description__ = "list available active COM ports"
 __url__ = "https://github.com/joshschmelzle/lscom"
-__version__ = "0.0.2"
+__version__ = "0.0.4"
 __author__ = "Josh Schmelzle"
 __author_email__ = "josh@joshschmelzle.com"
 __license__ = "MIT"

lscom/app.py

@@ -11,6 +11,7 @@ main app code
 """
 
 import glob
+import os
 import sys
 
 try:
@@ -23,6 +24,44 @@ except ModuleNotFoundError:
 class lscom:
     """Main application class."""
 
+    def check_serial_permissions(self):
+        """
+        Check if current user has permissions for serial port access on Linux.
+
+        Add to dialout:
+            sudo usermod -a -G dialout $USER
+
+        Remove from dialout:
+            sudo gpasswd -d $USER dialout
+
+        :returns:
+            Tuple: (bool, message)
+        """
+        if not sys.platform.startswith("linux"):
+            return True, "Permission check required"
+
+        try:
+            import grp
+
+            dialout = grp.getgrnam("dialout")
+            groups = os.getgroups()
+            user = os.getlogin()
+            if dialout.gr_gid in groups:
+                return True, f"{user} has dialout group access"
+            else:
+                return (
+                    False,
+                    f"""
+    {user} is not in the dialout group. To fix:
+    1. Run: sudo usermod -a -G dialout {user}
+    2. Log out and back in for the changes to take effect
+    """,
+                )
+        except KeyError:
+            return False, "dialout group not found"
+        except Exception as error:
+            return False, f"Error checking permissions: {str(error)}"
+
     def get_active_serial_port_names(self):
         """Lists serial port names
 
@@ -31,6 +70,9 @@ class lscom:
         :returns:
             A list of the serial ports available on the system
         """
+        has_permissions, message = self.check_serial_permissions()
+        if not has_permissions:
+            print(message)
         if sys.platform.startswith("win"):
             ports = ["COM%s" % (i + 1) for i in range(256)]
         elif sys.platform.startswith("linux") or sys.platform.startswith("cygwin"):

{lscom-0.0.2.dist-info → lscom-0.0.4.dist-info}/METADATA

@@ -1,13 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: lscom
-Version: 0.0.2
+Version: 0.0.4
 Summary: list available active COM ports
 Home-page: https://github.com/joshschmelzle/lscom
 Author: Josh Schmelzle
 Author-email: josh@joshschmelzle.com
 License: MIT
 Keywords: com,com ports,serial
-Platform: UNKNOWN
 Classifier: Natural Language :: English
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python :: 3.2
@@ -16,7 +15,20 @@ Classifier: Intended Audience :: System Administrators
 Classifier: Topic :: Utilities
 Requires-Python: >3.2,
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: pyserial
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 ![pypi-badge](https://img.shields.io/pypi/v/lscom) ![pypi-format](https://img.shields.io/pypi/format/lscom) ![pypi-implementation](https://img.shields.io/pypi/implementation/lscom) ![pypi-version](https://img.shields.io/pypi/pyversions/lscom) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/joshschmelzle/lscom/blob/main/CODE_OF_CONDUCT.md)
 
@@ -31,7 +43,7 @@ $ lscom
 ['COM3']
 ```
 
-## PyPI Installation
+## Installation from PyPI
 
 ```bash
 python -m pip install lscom
@@ -60,5 +72,3 @@ To remove:
 ```bash
 python -m pip uninstall lscom
 ```
-
-

lscom-0.0.4.dist-info/RECORD

@@ -0,0 +1,10 @@
+lscom/__init__.py,sha256=WtN4T7mOGywQBrXJV6LI-LVOEO4VsVYv_IDUk_ZzWFY,68
+lscom/__main__.py,sha256=ZOehmKf9gxckGPnG4ZLXmWQt_KHoyS0_gFAzyjC6nJE,1245
+lscom/__version__.py,sha256=jnKiHA1ZjrPVdDgBx54HmGwQU_WI26hxuE4d4ZQQEOs,355
+lscom/app.py,sha256=byM7H9M7J1uWEv3XAD0Y-acPYiR1781E5V9x20r_1lk,3168
+lscom-0.0.4.dist-info/licenses/LICENSE,sha256=sCQdvgDLxhhGvVufZs7UIRmNCbQTtxgILkaTTJhWZVY,1092
+lscom-0.0.4.dist-info/METADATA,sha256=nIRdvB9lKwTAm1CFuqtFHSqgnzJrmPQAv-bL9GbxRfs,2148
+lscom-0.0.4.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+lscom-0.0.4.dist-info/entry_points.txt,sha256=a7EcCLxFdb5WVmcy0RkzECIvPgPIumowQlEbOWoWl0k,46
+lscom-0.0.4.dist-info/top_level.txt,sha256=7aXJNRvNg3caDlTXuU_fLFVJD0dhaZG84UdVRUxLqcc,6
+lscom-0.0.4.dist-info/RECORD,,

{lscom-0.0.2.dist-info → lscom-0.0.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.38.4)
+Generator: setuptools (80.7.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{lscom-0.0.2.dist-info → lscom-0.0.4.dist-info}/entry_points.txt

@@ -1,3 +1,2 @@
 [console_scripts]
 lscom = lscom.__main__:main
-

lscom/helpers.py

@@ -1,27 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# |  _  _  _  ._ _
-# | _> (_ (_) | | |
-
-"""
-lscom.helpers
-~~~~~~~~~~~~~
-
-helper functions
-"""
-
-import argparse
-
-from lscom.__version__ import __version__
-
-
-def setup_parser():
-    """Set default values and handle arg parser."""
-    parser = argparse.ArgumentParser(
-        formatter_class=argparse.RawDescriptionHelpFormatter,
-        description="lscom: list and discover available COM ports",
-    )
-    parser.add_argument(
-        "--version", "-v", action="version", version=f"lscom version is {__version__}"
-    )
-    return parser

lscom/lscom.py

@@ -1,39 +0,0 @@
-# -*- coding: utf-8 -*-
-
-import glob
-import sys
-
-try:
-    import serial # type: ignore
-except ModuleNotFoundError:
-    print("required module pyserial not found... exiting...")
-    sys.exit(-1)
-
-
-def list_active_serial_port_names():
-    """Lists serial port names
-
-    :raises EnvironmentError:
-        On unsupported or unknown platforms
-    :returns:
-        A list of the serial ports available on the system
-    """
-    if sys.platform.startswith("win"):
-        ports = ["COM%s" % (i + 1) for i in range(256)]
-    elif sys.platform.startswith("linux") or sys.platform.startswith("cygwin"):
-        # this excludes your current terminal "/dev/tty"
-        ports = glob.glob("/dev/tty[A-Za-z]*")
-    elif sys.platform.startswith("darwin"):
-        ports = glob.glob("/dev/tty.*")
-    else:
-        raise EnvironmentError("Unsupported platform")
-
-    result = []
-    for port in ports:
-        try:
-            _serial = serial.Serial(port)
-            _serial.close()
-            result.append(port)
-        except (OSError, serial.SerialException):
-            pass
-    return result

lscom-0.0.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-lscom/__init__.py,sha256=WtN4T7mOGywQBrXJV6LI-LVOEO4VsVYv_IDUk_ZzWFY,68
-lscom/__main__.py,sha256=6RCIzGVNc9T5bHx65GvmyDBoO6JYVZmMStT2mSmwJIU,953
-lscom/__version__.py,sha256=xEY4OgWJuvOGR4z9UDXtGJWkxoi0oUC9nZHTx90AILM,357
-lscom/app.py,sha256=ssUiyLUc2lYfp87YhqjEDP0Uj22OMO9LWail6uc4cOQ,1834
-lscom/helpers.py,sha256=SjIaLbAOGaINW1kartBVnvkdGBGmPv6PlKdtjd9j0cQ,590
-lscom/lscom.py,sha256=JFO3dhyGMgqLAc36wk7rL3NjPkVc-hvYqMjNUpDUV2w,1127
-lscom-0.0.2.dist-info/LICENSE,sha256=sCQdvgDLxhhGvVufZs7UIRmNCbQTtxgILkaTTJhWZVY,1092
-lscom-0.0.2.dist-info/METADATA,sha256=EMS_uT8TQZ027zZVk-E9QAnRD8wxL6B5swhTkaQO2tI,1877
-lscom-0.0.2.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-lscom-0.0.2.dist-info/entry_points.txt,sha256=6JBCsARBUs1UcpssS-LLrI7bfS67xieDcWq404aXEVU,47
-lscom-0.0.2.dist-info/top_level.txt,sha256=7aXJNRvNg3caDlTXuU_fLFVJD0dhaZG84UdVRUxLqcc,6
-lscom-0.0.2.dist-info/RECORD,,