Merge pull request #2 from ianhi/local-import

use local module

Author: ianhi

.gitignore

@@ -150,4 +150,4 @@ static
 # failed downloads
 compressed/*?raw=true
 
-_version.py
+_version.py

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+exclude: '(JSON|boards)'
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.0.1

README.md

@@ -4,4 +4,4 @@ A small library to determine which serial ports are arduino style boards.
 
 ```bash
 pip install -e .
-```
+```

find_arduino/__init__.py

@@ -2,9 +2,9 @@
     from ._version import __version__
 except:
     __version__ = "unknown"
-from .detection import find_arduino
+from .detection import check_ports
 
 __all__ = [
     "__version__",
-    "find_arduino",
+    "check_ports",
 ]

find_arduino/detection.py

@@ -1,24 +1,28 @@
-from boards import boards_dict
-from serial.tools import list_ports
 import re
 
+from serial.tools import list_ports
+
+from .boards import boards_dict
+
+
 def check_ports():
     not_arduinos = []
     arduinos = []
     for connection in list_ports.comports():
-        port,hwid,desc = connection
+        port, hwid, desc = connection
         vid_pid = re.search(r"(?<=VID\:PID\=)[0-9|A-Z|a-z]{4}\:[0-9|A-Z|a-z]{4}", desc)
         vid_pid = None if vid_pid is None else vid_pid.group()
         if vid_pid is None:
             not_arduinos.append(connection)
         else:
             try:
                 board = boards_dict[vid_pid]
-                arduinos.append((board,connection))
+                arduinos.append((board, connection))
             except KeyError:
                 not_arduinos.append(connection)
     return arduinos, not_arduinos
 
+
 if __name__ == "__main__":
     arduinos, not_arduinos = check_ports()
     for ard in arduinos:

pyproject.toml

@@ -7,4 +7,3 @@ write_to = "find_arduino/_version.py"
 
 [tool.isort]
 profile = "black"
-

setup.cfg

@@ -1,14 +1,17 @@
 [metadata]
-name = find-arduino
+name = find_arduino
+long_description = file: README.md
+long_description_content_type = text/markdown
 url = https://github.com/ianhi/detect-arduino
 author = Ian Hunt-Isaak}}
 author_email = ianhuntisaak@gmail.com
 license = BSD-3 Clause
 classifiers =
-    Development Status :: 2 - Pre-Alpha
     'BSD license': 'License :: OSI Approved :: BSD License',
+    Development Status :: 2 - Pre-Alpha
     Natural Language :: English
     Programming Language :: Python :: 3
+    Programming Language :: Python :: 3 :: Only
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
@@ -17,8 +20,14 @@ project_urls =
 
 [options]
 packages = find:
+install_requires =
+    pyserial
 python_requires = >=3.7
 setup_requires =
     setuptools_scm
-install_requires =
-    pyserial
+
+[flake8]
+exclude = docs,_version.py,.eggs,examples
+max-line-length = 88
+docstring-convention = numpy
+ignore = D100, D213, D401, D413, D107, W503

setup.py

@@ -1,3 +1,3 @@
 from setuptools import setup
 
-setup()
+setup()