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

lscom/__init__.py

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# |  _  _  _  ._ _
-# | _> (_ (_) | | |
+# -*- coding: utf-8 -*-
+
+# |  _  _  _  ._ _
+# | _> (_ (_) | | |

lscom/__main__.py

@@ -1,50 +1,50 @@
-# -*- coding: utf-8 -*-
-
-# |  _  _  _  ._ _
-# | _> (_ (_) | | |
-
-"""
-lscom
-~~~~~
-
-list available serial ports
-"""
-
-import sys
-
-from lscom import helpers
-from lscom.__version__ import __title__, __version__
-from lscom.app import run
-
-PY_MAJOR = 3
-PY_MINOR = 2
-MINIMUM_PYTHON_VERISON = "3.2"
-
-
-def check_python_version():  # type: ignore
-    """Use old-school .format() method for if someone uses with very old Python."""
-    msg = """
-
-{title} version {pkgv} requires Python version {pyv} or higher.
-""".format(
-        title=__title__, pkgv=__version__, pyv=MINIMUM_PYTHON_VERISON
-    )
-    if sys.version_info < (PY_MAJOR, PY_MINOR):
-        raise ValueError(msg)
-
-
-def main():
-    parser = helpers.setup_parser()
-    args = parser.parse_args()  # noqa: F841
-    run()
-
-
-def init():
-    check_python_version()  # type: ignore
-
-    if __name__ == "__main__":
-        main()
-        sys.exit(0)
-
-
-init()
+# -*- coding: utf-8 -*-
+
+# |  _  _  _  ._ _
+# | _> (_ (_) | | |
+
+"""
+lscom
+~~~~~
+
+list available serial ports
+"""
+
+import sys
+
+from lscom import helpers
+from lscom.__version__ import __title__, __version__
+from lscom.app import run
+
+PY_MAJOR = 3
+PY_MINOR = 2
+MINIMUM_PYTHON_VERISON = "3.2"
+
+
+def check_python_version():  # type: ignore
+    """Use old-school .format() method for if someone uses with very old Python."""
+    msg = """
+
+{title} version {pkgv} requires Python version {pyv} or higher.
+""".format(
+        title=__title__, pkgv=__version__, pyv=MINIMUM_PYTHON_VERISON
+    )
+    if sys.version_info < (PY_MAJOR, PY_MINOR):
+        raise ValueError(msg)
+
+
+def main():
+    parser = helpers.setup_parser()
+    args = parser.parse_args()  # noqa: F841
+    run()
+
+
+def init():
+    check_python_version()  # type: ignore
+
+    if __name__ == "__main__":
+        main()
+        sys.exit(0)
+
+
+init()

lscom/__version__.py

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

lscom/app.py

@@ -1,68 +1,109 @@
-# -*- coding: utf-8 -*-
-
-# |  _  _  _  ._ _
-# | _> (_ (_) | | |
-
-"""
-lscom.app
-~~~~~~~~~
-
-main app code
-"""
-
-import glob
-import sys
-
-try:
-    import serial  # type: ignore
-except ModuleNotFoundError:
-    print("required module pyserial not found... exiting...")
-    sys.exit(-1)
-
-
-class lscom:
-    """Main application class."""
-
-    def get_active_serial_port_names(self):
-        """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(
-                "appears to be an unsupported platform", sys.platform
-            )
-
-        result = []
-        for port in ports:
-            try:
-                _serial = serial.Serial(port)
-                _serial.close()
-                result.append(port)
-            except (OSError, serial.SerialException):
-                pass
-        return result
-
-    def run(self):
-        serials = self.get_active_serial_port_names()
-        if len(serials) > 0:
-            print("{0} serial ports detected and available:".format(len(serials)))
-            for _ in serials:
-                print(_)
-        else:
-            print("no available serial ports detected")
-
-
-def run() -> None:
-    """Run the application."""
-    lscom().run()
+# -*- coding: utf-8 -*-
+
+# |  _  _  _  ._ _
+# | _> (_ (_) | | |
+
+"""
+lscom.app
+~~~~~~~~~
+
+main app code
+"""
+
+import glob
+import grp
+import os
+import sys
+
+try:
+    import serial  # type: ignore
+except ModuleNotFoundError:
+    print("required module pyserial not found... exiting...")
+    sys.exit(-1)
+
+
+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:
+            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
+
+        :raises EnvironmentError:
+            On unsupported or unknown platforms
+        :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"):
+            # 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(
+                "appears to be an unsupported platform", sys.platform
+            )
+
+        result = []
+        for port in ports:
+            try:
+                _serial = serial.Serial(port)
+                _serial.close()
+                result.append(port)
+            except (OSError, serial.SerialException):
+                pass
+        return result
+
+    def run(self):
+        serials = self.get_active_serial_port_names()
+        if len(serials) > 0:
+            print("{0} serial ports detected and available:".format(len(serials)))
+            for _ in serials:
+                print(_)
+        else:
+            print("no available serial ports detected")
+
+
+def run() -> None:
+    """Run the application."""
+    lscom().run()

lscom/helpers.py

@@ -1,27 +1,27 @@
-# -*- 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
+# -*- 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-0.0.2.dist-info → lscom-0.0.3.dist-info}/LICENSE

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

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

@@ -1,64 +1,73 @@
-Metadata-Version: 2.1
-Name: lscom
-Version: 0.0.2
-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
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: System Administrators
-Classifier: Topic :: Utilities
-Requires-Python: >3.2,
-Description-Content-Type: text/markdown
-Requires-Dist: pyserial
-
-![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)
-
-# lscom: list and discover available COM ports
-
-More quickly identify which COM ports are available for use. Any COM ports already in use will not be listed. `lscom` should work cross platform (Linux, macOS, Windows), but has not been extensively tested. Have a problem? Open an issue.
-
-## Usage Example
-
-```
-$ lscom
-['COM3']
-```
-
-## PyPI Installation
-
-```bash
-python -m pip install lscom
-```
-
-## Local Installation Example
-
-To install manually:
-
-1. Clone repository.
-
-2. Open the terminal to the root of the repository.
-
-3. Run-
-
-```bash
-python -m pip install .
-```
-
-You should now be able to run `lscom` from your terminal
-
-If you can't, check and make sure the scripts directory is included in the system path environment variable.
-
-To remove:
-
-```bash
-python -m pip uninstall lscom
-```
-
-
+Metadata-Version: 2.2
+Name: lscom
+Version: 0.0.3
+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
+Classifier: Natural Language :: English
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3.2
+Classifier: Intended Audience :: Developers
+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: 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)
+
+# lscom: list and discover available COM ports
+
+More quickly identify which COM ports are available for use. Any COM ports already in use will not be listed. `lscom` should work cross platform (Linux, macOS, Windows), but has not been extensively tested. Have a problem? Open an issue.
+
+## Usage Example
+
+```
+$ lscom
+['COM3']
+```
+
+## Installation from PyPI
+
+```bash
+python -m pip install lscom
+```
+
+## Local Installation Example
+
+To install manually:
+
+1. Clone repository.
+
+2. Open the terminal to the root of the repository.
+
+3. Run-
+
+```bash
+python -m pip install .
+```
+
+You should now be able to run `lscom` from your terminal
+
+If you can't, check and make sure the scripts directory is included in the system path environment variable.
+
+To remove:
+
+```bash
+python -m pip uninstall lscom
+```

lscom-0.0.3.dist-info/RECORD

@@ -0,0 +1,11 @@
+lscom/__init__.py,sha256=ifPM1hOek6le3YZWMc0ZsuR_-oaAW3F1I8-YsT4XzyY,64
+lscom/__main__.py,sha256=fBr3WZSCKZf77YFl5tNveT4BPfqiLYn7MtST2-yEoUE,903
+lscom/__version__.py,sha256=-fANk4luWtS5MhpViB62WNuYLDctjU5mlrSHW5XpPlU,343
+lscom/app.py,sha256=62WUIzvAlyTKZqsZbaXuNoX1sKHRwNYjZY5N0W5OFGs,3045
+lscom/helpers.py,sha256=Yqtg3JBjRPsujY0hHK46GFlzWVSiew2fIuj70C1o8BI,563
+lscom-0.0.3.dist-info/LICENSE,sha256=kH0BjvpwBWfRwgjUIR_aL7aBaJLfp-U41rsJW1jKF8M,1071
+lscom-0.0.3.dist-info/METADATA,sha256=ZJ3R5N2b9CcvffGBP2np-0mr9M5nOPBrFHjOz77EOz8,2052
+lscom-0.0.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+lscom-0.0.3.dist-info/entry_points.txt,sha256=a7EcCLxFdb5WVmcy0RkzECIvPgPIumowQlEbOWoWl0k,46
+lscom-0.0.3.dist-info/top_level.txt,sha256=7aXJNRvNg3caDlTXuU_fLFVJD0dhaZG84UdVRUxLqcc,6
+lscom-0.0.3.dist-info/RECORD,,

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

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

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

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

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,,