circup 2.0.2__tar.gz → 2.0.4__tar.gz

{circup-2.0.2 → circup-2.0.4}/.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
     -   id: black
         exclude: "^tests/bad_python.py$"
 -   repo: https://github.com/pycqa/pylint
-    rev: v2.15.5
+    rev: v3.1.0
     hooks:
     -   id: pylint
         name: lint (examples)

{circup-2.0.2 → circup-2.0.4}/.pylintrc

@@ -246,7 +246,7 @@ ignore-docstrings=yes
 ignore-imports=yes
 
 # Minimum lines number of a similarity.
-min-similarity-lines=4
+min-similarity-lines=8
 
 
 [BASIC]

{circup-2.0.2/circup.egg-info → circup-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: circup
-Version: 2.0.2
+Version: 2.0.4
 Summary: A tool to manage/update libraries on CircuitPython devices.
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT License

{circup-2.0.2 → circup-2.0.4}/circup/backends.py

@@ -277,7 +277,7 @@ class WebBackend(Backend):
     """
 
     def __init__(  # pylint: disable=too-many-arguments
-        self, host, password, logger, timeout=10, version_override=None
+        self, host, port, password, logger, timeout=10, version_override=None
     ):
         super().__init__(logger)
         if password is None:
@@ -297,8 +297,9 @@ class WebBackend(Backend):
         self.FS_PATH = "fs/"
         self.LIB_DIR_PATH = f"{self.FS_PATH}lib/"
         self.host = host
+        self.port = port
         self.password = password
-        self.device_location = f"http://:{self.password}@{self.host}"
+        self.device_location = f"http://:{self.password}@{self.host}:{self.port}"
 
         self.session = requests.Session()
         self.session.mount(self.device_location, HTTPAdapter(max_retries=5))
@@ -306,6 +307,9 @@ class WebBackend(Backend):
         self.timeout = timeout
         self.version_override = version_override
 
+    def __repr__(self):
+        return f"<WebBackend @{self.device_location}>"
+
     def install_file_http(self, source, location=None):
         """
         Install file to device using web workflow.

{circup-2.0.2 → circup-2.0.4}/circup/command_utils.py

@@ -610,7 +610,7 @@ def libraries_from_code_py(code_py, mod_names):
     return [r for r in imports if r in mod_names]
 
 
-def get_device_path(host, password, path):
+def get_device_path(host, port, password, path):
     """
     :param host Hostname or IP address.
     :param password REST API password.
@@ -621,7 +621,7 @@ def get_device_path(host, password, path):
         device_path = path
     elif host:
         # pylint: enable=no-member
-        device_path = f"http://:{password}@" + host
+        device_path = f"http://:{password}@{host}:{port}"
     else:
         device_path = find_device()
     return device_path

{circup-2.0.2 → circup-2.0.4}/circup/commands.py

@@ -11,6 +11,7 @@ and the respective Backends which *are* tested. Most of the logic of the followi
 functions is to prepare things for presentation to / interaction with the user.
 """
 import os
+import subprocess
 import time
 import sys
 import re
@@ -56,6 +57,9 @@ from circup.command_utils import (
     "--host",
     help="Hostname or IP address of a device. Overrides automatic path detection.",
 )
+@click.option(
+    "--port", help="Port to contact. Overrides automatic path detection.", default=80
+)
 @click.option(
     "--password",
     help="Password to use for authentication when --host is used."
@@ -85,7 +89,7 @@ from circup.command_utils import (
 )
 @click.pass_context
 def main(  # pylint: disable=too-many-locals
-    ctx, verbose, path, host, password, timeout, board_id, cpy_version
+    ctx, verbose, path, host, port, password, timeout, board_id, cpy_version
 ):  # pragma: no cover
     """
     A tool to manage and update libraries on a CircuitPython device.
@@ -97,7 +101,7 @@ def main(  # pylint: disable=too-many-locals
     if password is None:
         password = os.getenv("CIRCUP_WEBWORKFLOW_PASSWORD")
 
-    device_path = get_device_path(host, password, path)
+    device_path = get_device_path(host, port, password, path)
 
     using_webworkflow = "host" in ctx.params.keys() and ctx.params["host"] is not None
 
@@ -113,6 +117,7 @@ def main(  # pylint: disable=too-many-locals
         try:
             ctx.obj["backend"] = WebBackend(
                 host=host,
+                port=port,
                 password=password,
                 logger=logger,
                 timeout=timeout,
@@ -304,6 +309,12 @@ def list_cli(ctx):  # pragma: no cover
 @click.option(
     "--upgrade", "-U", is_flag=True, help="Upgrade modules that are already installed."
 )
+@click.option(
+    "--stubs",
+    "-s",
+    is_flag=True,
+    help="Install stubs module from PyPi for context in IDE.",
+)
 @click.option(
     "--auto-file",
     default=None,
@@ -312,7 +323,7 @@ def list_cli(ctx):  # pragma: no cover
 )
 @click.pass_context
 def install(
-    ctx, modules, pyext, requirement, auto, auto_file, upgrade=False
+    ctx, modules, pyext, requirement, auto, auto_file, upgrade=False, stubs=False
 ):  # pragma: no cover
     """
     Install a named module(s) onto the device. Multiple modules
@@ -320,6 +331,7 @@ def install(
     separated by a space. Modules can be from a Bundle or local filepaths.
     """
 
+    # pylint: disable=too-many-branches
     # TODO: Ensure there's enough space on the device
     available_modules = get_bundle_versions(get_bundles_list())
     mod_names = {}
@@ -373,6 +385,24 @@ def install(
                 upgrade,
             )
 
+            if stubs:
+                library_stubs = "adafruit-circuitpython-{}".format(
+                    library.replace("adafruit_", "")
+                )
+                try:
+                    output = subprocess.check_output(["pip", "install", library_stubs])
+                    if (
+                        f"Requirement already satisfied: {library_stubs}"
+                        in output.decode()
+                    ):
+                        click.echo(f"'{library}' stubs already installed.")
+                    else:
+                        click.echo(f"Installed '{library}' stubs.")
+                except subprocess.CalledProcessError:
+                    click.secho(
+                        f"Could not install stubs module {library_stubs}", fg="yellow"
+                    )
+
 
 @main.command()
 @click.option("--overwrite", is_flag=True, help="Overwrite the file if it exists.")
@@ -697,7 +727,7 @@ def bundle_remove(bundle, reset):
     bundles_local_dict = get_bundles_local_dict()
     modified = False
     for bun in bundle:
-        # cleanup in case seombody pastes the URL to the repo/releases
+        # cleanup in case somebody pastes the URL to the repo/releases
         bun = re.sub(r"https?://github.com/([^/]+/[^/]+)(/.*)?", r"\1", bun)
         found = False
         for name, repo in list(bundles_local_dict.items()):

{circup-2.0.2 → circup-2.0.4}/circup/shared.py

@@ -10,8 +10,8 @@ import glob
 import os
 import re
 import json
+import importlib.resources
 import appdirs
-import pkg_resources
 import requests
 
 #: Version identifier for a bad MPY file format
@@ -27,9 +27,8 @@ PLATFORMS = {"py": "py", "8mpy": "8.x-mpy", "9mpy": "9.x-mpy"}
 REQUESTS_TIMEOUT = 30
 
 #: The path to the JSON file containing the metadata about the bundles.
-BUNDLE_CONFIG_FILE = pkg_resources.resource_filename(
-    "circup", "config/bundle_config.json"
-)
+BUNDLE_CONFIG_FILE = importlib.resources.files("circup") / "config/bundle_config.json"
+
 #: Overwrite the bundles list with this file (only done manually)
 BUNDLE_CONFIG_OVERWRITE = os.path.join(DATA_DIR, "bundle_config.json")
 #: The path to the JSON file containing the local list of bundles.

{circup-2.0.2 → circup-2.0.4/circup.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: circup
-Version: 2.0.2
+Version: 2.0.4
 Summary: A tool to manage/update libraries on CircuitPython devices.
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT License