circup 1.7.0__tar.gz → 1.8.0__tar.gz

{circup-1.7.0/circup.egg-info → circup-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: circup
-Version: 1.7.0
+Version: 1.8.0
 Summary: A tool to manage/update libraries on CircuitPython devices.
 Home-page: https://github.com/adafruit/circup
 Author: Adafruit Industries
@@ -59,14 +59,14 @@ Requires-Dist: twine; extra == "dev"
 Provides-Extra: all
 Requires-Dist: wheel; extra == "all"
 Requires-Dist: pytest-faulthandler; extra == "all"
-Requires-Dist: pytest-random-order>=1.0.0; extra == "all"
+Requires-Dist: coverage; extra == "all"
 Requires-Dist: pylint; extra == "all"
 Requires-Dist: pytest; extra == "all"
-Requires-Dist: coverage; extra == "all"
-Requires-Dist: black; extra == "all"
-Requires-Dist: pytest-cov; extra == "all"
 Requires-Dist: twine; extra == "all"
 Requires-Dist: sphinx; extra == "all"
+Requires-Dist: black; extra == "all"
+Requires-Dist: pytest-random-order>=1.0.0; extra == "all"
+Requires-Dist: pytest-cov; extra == "all"
 
 
 CircUp
@@ -165,6 +165,8 @@ To get help, just type the command::
       --host TEXT         Hostname or IP address of a device. Overrides automatic
                           path detection.
       --password TEXT     Password to use for authentication when --host is used.
+      --timeout INTEGER   Specify the timeout in seconds for any network
+                          operations.
       --board-id TEXT     Manual Board ID of the CircuitPython device. If provided
                           in combination with --cpy-version, it overrides the
                           detected board ID.
@@ -177,6 +179,7 @@ To get help, just type the command::
       bundle-add     Add bundles to the local bundles list, by "user/repo"...
       bundle-remove  Remove one or more bundles from the local bundles list.
       bundle-show    Show the list of bundles, default and local, with URL,...
+      example        Copy named example(s) from a bundle onto the device.
       freeze         Output details of all the modules found on the connected...
       install        Install a named module(s) onto the device.
       list           Lists all out of date modules found on the connected...

{circup-1.7.0 → circup-1.8.0}/README.rst

@@ -95,6 +95,8 @@ To get help, just type the command::
       --host TEXT         Hostname or IP address of a device. Overrides automatic
                           path detection.
       --password TEXT     Password to use for authentication when --host is used.
+      --timeout INTEGER   Specify the timeout in seconds for any network
+                          operations.
       --board-id TEXT     Manual Board ID of the CircuitPython device. If provided
                           in combination with --cpy-version, it overrides the
                           detected board ID.
@@ -107,6 +109,7 @@ To get help, just type the command::
       bundle-add     Add bundles to the local bundles list, by "user/repo"...
       bundle-remove  Remove one or more bundles from the local bundles list.
       bundle-show    Show the list of bundles, default and local, with URL,...
+      example        Copy named example(s) from a bundle onto the device.
       freeze         Output details of all the modules found on the connected...
       install        Install a named module(s) onto the device.
       list           Lists all out of date modules found on the connected...

{circup-1.7.0 → circup-1.8.0}/circup/backends.py

@@ -16,7 +16,6 @@ import requests
 from requests.adapters import HTTPAdapter
 from requests.auth import HTTPBasicAuth
 
-
 from circup.shared import DATA_DIR, BAD_FILE_FORMAT, extract_metadata, _get_modules_file
 
 #: The location to store a local copy of code.py for use with --auto and
@@ -79,13 +78,13 @@ class Backend:
         """
         raise NotImplementedError
 
-    def _install_module_py(self, metadata):
+    def install_module_py(self, metadata, location=None):
         """
         To be overridden by subclass
         """
         raise NotImplementedError
 
-    def _install_module_mpy(self, bundle, metadata):
+    def install_module_mpy(self, bundle, metadata):
         """
         To be overridden by subclass
         """
@@ -93,7 +92,7 @@ class Backend:
 
     # pylint: disable=too-many-locals,too-many-branches,too-many-arguments,too-many-nested-blocks
     def install_module(
-        self, device_path, device_modules, name, pyext, mod_names
+        self, device_path, device_modules, name, pyext, mod_names, upgrade=False
     ):  # pragma: no cover
         """
         Finds a connected device and installs a given module name if it
@@ -108,14 +107,27 @@ class Backend:
                         source or from a pre-compiled module
         :param mod_names: Dictionary of metadata from modules that can be generated
                            with get_bundle_versions()
+        :param bool upgrade: Upgrade the specified modules if they're already installed.
         """
         if not name:
             click.echo("No module name(s) provided.")
         elif name in mod_names:
             # Grab device modules to check if module already installed
             if name in device_modules:
-                click.echo("'{}' is already installed.".format(name))
-                return
+                if not upgrade:
+                    # skip already installed modules if no -upgrade flag
+                    click.echo("'{}' is already installed.".format(name))
+                    return
+
+                # uninstall the module before installing
+                name = name.lower()
+                _mod_names = {}
+                for module_item, _metadata in device_modules.items():
+                    _mod_names[module_item.replace(".py", "").lower()] = _metadata
+                if name in _mod_names:
+                    _metadata = _mod_names[name]
+                    module_path = _metadata["path"]
+                    self.uninstall(device_path, module_path)
 
             library_path = (
                 os.path.join(device_path, self.LIB_DIR_PATH)
@@ -159,10 +171,10 @@ class Backend:
 
             if pyext:
                 # Use Python source for module.
-                self._install_module_py(metadata)
+                self.install_module_py(metadata)
             else:
                 # Use pre-compiled mpy modules.
-                self._install_module_mpy(bundle, metadata)
+                self.install_module_mpy(bundle, metadata)
             click.echo("Installed '{}'.".format(name))
         else:
             click.echo("Unknown module named, '{}'.".format(name))
@@ -219,6 +231,12 @@ class Backend:
             board_id = ""
         return circuit_python, board_id
 
+    def file_exists(self, filepath):
+        """
+        To be overriden by subclass
+        """
+        raise NotImplementedError
+
 
 def _writeable_error():
     click.secho(
@@ -250,7 +268,8 @@ class WebBackend(Backend):
                 else "Could not find or connect to specified device"
             ) from exc
 
-        self.LIB_DIR_PATH = "fs/lib/"
+        self.FS_PATH = "fs/"
+        self.LIB_DIR_PATH = f"{self.FS_PATH}lib/"
         self.host = host
         self.password = password
         self.device_location = f"http://:{self.password}@{self.host}"
@@ -260,14 +279,20 @@ class WebBackend(Backend):
         self.library_path = self.device_location + "/" + self.LIB_DIR_PATH
         self.timeout = timeout
 
-    def install_file_http(self, source):
+    def install_file_http(self, source, location=None):
         """
         Install file to device using web workflow.
         :param source source file.
+        :param location the location on the device to copy the source
+          directory in to. If omitted is CIRCUITPY/lib/ used.
         """
         file_name = source.split(os.path.sep)
         file_name = file_name[-2] if file_name[-1] == "" else file_name[-1]
-        target = self.device_location + "/" + self.LIB_DIR_PATH + file_name
+
+        if location is None:
+            target = self.device_location + "/" + self.LIB_DIR_PATH + file_name
+        else:
+            target = self.device_location + "/" + self.FS_PATH + location + file_name
 
         auth = HTTPBasicAuth("", self.password)
 
@@ -277,14 +302,19 @@ class WebBackend(Backend):
                 _writeable_error()
             r.raise_for_status()
 
-    def install_dir_http(self, source):
+    def install_dir_http(self, source, location=None):
         """
         Install directory to device using web workflow.
         :param source source directory.
+        :param location the location on the device to copy the source
+          directory in to. If omitted is CIRCUITPY/lib/ used.
         """
         mod_name = source.split(os.path.sep)
         mod_name = mod_name[-2] if mod_name[-1] == "" else mod_name[-1]
-        target = self.device_location + "/" + self.LIB_DIR_PATH + mod_name
+        if location is None:
+            target = self.device_location + "/" + self.LIB_DIR_PATH + mod_name
+        else:
+            target = self.device_location + "/" + self.FS_PATH + location + mod_name
         target = target + "/" if target[:-1] != "/" else target
         url = urlparse(target)
         auth = HTTPBasicAuth("", url.password)
@@ -490,7 +520,7 @@ class WebBackend(Backend):
                 _writeable_error()
             r.raise_for_status()
 
-    def _install_module_mpy(self, bundle, metadata):
+    def install_module_mpy(self, bundle, metadata):
         """
         :param bundle library bundle.
         :param library_path library path
@@ -514,7 +544,7 @@ class WebBackend(Backend):
             raise IOError("Cannot find compiled version of module.")
 
     # pylint: enable=too-many-locals,too-many-branches
-    def _install_module_py(self, metadata):
+    def install_module_py(self, metadata, location=None):
         """
         :param library_path library path
         :param metadata dictionary.
@@ -522,10 +552,10 @@ class WebBackend(Backend):
 
         source_path = metadata["path"]  # Path to Python source version.
         if os.path.isdir(source_path):
-            self.install_dir_http(source_path)
+            self.install_dir_http(source_path, location=location)
 
         else:
-            self.install_file_http(source_path)
+            self.install_file_http(source_path, location=location)
 
     def get_auto_file_path(self, auto_file_path):
         """
@@ -560,6 +590,18 @@ class WebBackend(Backend):
         """
         self._update_http(module)
 
+    def file_exists(self, filepath):
+        """
+        return True if the file exists, otherwise False.
+        """
+        auth = HTTPBasicAuth("", self.password)
+        resp = requests.get(
+            self.get_file_path(filepath), auth=auth, timeout=self.timeout
+        )
+        if resp.status_code == 200:
+            return True
+        return False
+
     def _update_http(self, module):
         """
         Update the module using web workflow.
@@ -733,10 +775,9 @@ class DiskBackend(Backend):
         if not os.path.exists(library_path):  # pragma: no cover
             os.makedirs(library_path)
 
-    def _install_module_mpy(self, bundle, metadata):
+    def install_module_mpy(self, bundle, metadata):
         """
         :param bundle library bundle.
-        :param library_path library path
         :param metadata dictionary.
         """
         module_name = os.path.basename(metadata["path"]).replace(".py", ".mpy")
@@ -763,21 +804,26 @@ class DiskBackend(Backend):
             raise IOError("Cannot find compiled version of module.")
 
     # pylint: enable=too-many-locals,too-many-branches
-    def _install_module_py(self, metadata):
+    def install_module_py(self, metadata, location=None):
         """
-        :param library_path library path
         :param metadata dictionary.
+        :param location the location on the device to copy the py module to.
+          If omitted is CIRCUITPY/lib/ used.
         """
+        if location is None:
+            location = self.library_path
+        else:
+            location = os.path.join(self.device_location, location)
 
         source_path = metadata["path"]  # Path to Python source version.
         if os.path.isdir(source_path):
             target = os.path.basename(os.path.dirname(source_path))
-            target_path = os.path.join(self.library_path, target)
+            target_path = os.path.join(location, target)
             # Copy the directory.
             shutil.copytree(source_path, target_path)
         else:
             target = os.path.basename(source_path)
-            target_path = os.path.join(self.library_path, target)
+            target_path = os.path.join(location, target)
             # Copy file.
             shutil.copyfile(source_path, target_path)
 
@@ -825,6 +871,12 @@ class DiskBackend(Backend):
             os.remove(module.path)
             shutil.copyfile(module.bundle_path, module.path)
 
+    def file_exists(self, filepath):
+        """
+        return True if the file exists, otherwise False.
+        """
+        return os.path.exists(os.path.join(self.device_location, filepath))
+
     def get_file_path(self, filename):
         """
         returns the full path on the device to a given file name.

{circup-1.7.0 → circup-1.8.0}/circup/bundle.py

@@ -61,6 +61,20 @@ class Bundle:
             "lib",
         )
 
+    def examples_dir(self, platform):
+        """
+        This bundle's examples directory for the platform.
+
+        :param str platform: The platform identifier (py/6mpy/...).
+        :return: The path to the examples directory for the platform.
+        """
+        tag = self.current_tag
+        return os.path.join(
+            self.dir.format(platform=platform),
+            self.basename.format(platform=PLATFORMS[platform], tag=tag),
+            "examples",
+        )
+
     def requirements_for(self, library_name, toml_file=False):
         """
         The requirements file for this library.

{circup-1.7.0 → circup-1.8.0}/circup/command_utils.py

@@ -93,6 +93,23 @@ def completion_for_install(ctx, param, incomplete):
     return sorted(module_names)
 
 
+def completion_for_example(ctx, param, incomplete):
+    """
+    Returns the list of available modules for the command line tab-completion
+    with the ``circup example`` command.
+    """
+    # pylint: disable=unused-argument, consider-iterating-dictionary
+    available_examples = get_bundle_examples(get_bundles_list(), avoid_download=True)
+
+    matching_examples = [
+        example_path
+        for example_path in available_examples.keys()
+        if example_path.startswith(incomplete)
+    ]
+
+    return sorted(matching_examples)
+
+
 def ensure_latest_bundle(bundle):
     """
     Ensure that there's a copy of the latest library bundle available so circup
@@ -290,6 +307,43 @@ def get_bundle(bundle, tag):
     click.echo("\nOK\n")
 
 
+def get_bundle_examples(bundles_list, avoid_download=False):
+    """
+    Return a dictionary of metadata from examples in the all of the bundles
+    specified by bundles_list argument.
+
+    :param List[Bundle] bundles_list: List of supported bundles as Bundle objects.
+    :param bool avoid_download: if True, download the bundle only if missing.
+    :return: A dictionary of metadata about the examples available in the
+             library bundle.
+    """
+    # pylint: disable=too-many-nested-blocks
+    all_the_examples = dict()
+
+    try:
+        for bundle in bundles_list:
+            if not avoid_download or not os.path.isdir(bundle.lib_dir("py")):
+                ensure_latest_bundle(bundle)
+            path = bundle.examples_dir("py")
+            path_examples = _get_modules_file(path, logger)
+            for lib_name, lib_metadata in path_examples.items():
+                for _dir_level in os.walk(lib_metadata["path"]):
+                    for _file in _dir_level[2]:
+                        _parts = _dir_level[0].split(os.path.sep)
+                        _lib_name_index = _parts.index(lib_name)
+                        _dirs = _parts[_lib_name_index:]
+                        if _dirs[-1] == "":
+                            _dirs.pop(-1)
+                        slug = f"{os.path.sep}".join(_dirs + [_file.replace(".py", "")])
+                        all_the_examples[slug] = os.path.join(_dir_level[0], _file)
+
+    except NotADirectoryError:
+        # Bundle does not have new style examples directory
+        # so we cannot include its examples.
+        pass
+    return all_the_examples
+
+
 def get_bundle_versions(bundles_list, avoid_download=False):
     """
     Returns a dictionary of metadata from modules in the latest known release

{circup-1.7.0 → circup-1.8.0}/circup/commands.py

@@ -38,6 +38,8 @@ from circup.command_utils import (
     get_bundles_local_dict,
     save_local_bundles,
     get_bundles_dict,
+    completion_for_example,
+    get_bundle_examples,
 )
 
 
@@ -284,6 +286,9 @@ def list_cli(ctx):  # pragma: no cover
 @click.option(
     "--auto", "-a", is_flag=True, help="Install the modules imported in code.py."
 )
+@click.option(
+    "--upgrade", "-U", is_flag=True, help="Upgrade modules that are already installed."
+)
 @click.option(
     "--auto-file",
     default=None,
@@ -291,7 +296,9 @@ def list_cli(ctx):  # pragma: no cover
     " Also accepts an absolute path or a local ./ path.",
 )
 @click.pass_context
-def install(ctx, modules, pyext, requirement, auto, auto_file):  # pragma: no cover
+def install(
+    ctx, modules, pyext, requirement, auto, auto_file, upgrade=False
+):  # pragma: no cover
     """
     Install a named module(s) onto the device. Multiple modules
     can be installed at once by providing more than one module name, each
@@ -343,7 +350,51 @@ def install(ctx, modules, pyext, requirement, auto, auto_file):  # pragma: no co
         click.echo(f"Ready to install: {to_install}\n")
         for library in to_install:
             ctx.obj["backend"].install_module(
-                ctx.obj["DEVICE_PATH"], device_modules, library, pyext, mod_names
+                ctx.obj["DEVICE_PATH"],
+                device_modules,
+                library,
+                pyext,
+                mod_names,
+                upgrade,
+            )
+
+
+@main.command()
+@click.option("--overwrite", is_flag=True, help="Overwrite the file if it exists.")
+@click.argument(
+    "examples", required=True, nargs=-1, shell_complete=completion_for_example
+)
+@click.pass_context
+def example(ctx, examples, overwrite):
+    """
+    Copy named example(s) from a bundle onto the device. Multiple examples
+    can be installed at once by providing more than one example name, each
+    separated by a space.
+    """
+
+    for example_arg in examples:
+        available_examples = get_bundle_examples(
+            get_bundles_list(), avoid_download=True
+        )
+        if example_arg in available_examples:
+            filename = available_examples[example_arg].split(os.path.sep)[-1]
+
+            if overwrite or not ctx.obj["backend"].file_exists(filename):
+                click.echo(
+                    f"{'Copying' if not overwrite else 'Overwriting'}: {filename}"
+                )
+                ctx.obj["backend"].install_module_py(
+                    {"path": available_examples[example_arg]}, location=""
+                )
+            else:
+                click.secho(
+                    f"File: {filename} already exists. Use --overwrite if you wish to replace it.",
+                    fg="red",
+                )
+        else:
+            click.secho(
+                f"Error: {example_arg} was not found in any local bundle examples.",
+                fg="red",
             )
 
 

{circup-1.7.0 → circup-1.8.0/circup.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: circup
-Version: 1.7.0
+Version: 1.8.0
 Summary: A tool to manage/update libraries on CircuitPython devices.
 Home-page: https://github.com/adafruit/circup
 Author: Adafruit Industries
@@ -59,14 +59,14 @@ Requires-Dist: twine; extra == "dev"
 Provides-Extra: all
 Requires-Dist: wheel; extra == "all"
 Requires-Dist: pytest-faulthandler; extra == "all"
-Requires-Dist: pytest-random-order>=1.0.0; extra == "all"
+Requires-Dist: coverage; extra == "all"
 Requires-Dist: pylint; extra == "all"
 Requires-Dist: pytest; extra == "all"
-Requires-Dist: coverage; extra == "all"
-Requires-Dist: black; extra == "all"
-Requires-Dist: pytest-cov; extra == "all"
 Requires-Dist: twine; extra == "all"
 Requires-Dist: sphinx; extra == "all"
+Requires-Dist: black; extra == "all"
+Requires-Dist: pytest-random-order>=1.0.0; extra == "all"
+Requires-Dist: pytest-cov; extra == "all"
 
 
 CircUp
@@ -165,6 +165,8 @@ To get help, just type the command::
       --host TEXT         Hostname or IP address of a device. Overrides automatic
                           path detection.
       --password TEXT     Password to use for authentication when --host is used.
+      --timeout INTEGER   Specify the timeout in seconds for any network
+                          operations.
       --board-id TEXT     Manual Board ID of the CircuitPython device. If provided
                           in combination with --cpy-version, it overrides the
                           detected board ID.
@@ -177,6 +179,7 @@ To get help, just type the command::
       bundle-add     Add bundles to the local bundles list, by "user/repo"...
       bundle-remove  Remove one or more bundles from the local bundles list.
       bundle-show    Show the list of bundles, default and local, with URL,...
+      example        Copy named example(s) from a bundle onto the device.
       freeze         Output details of all the modules found on the connected...
       install        Install a named module(s) onto the device.
       list           Lists all out of date modules found on the connected...

{circup-1.7.0 → circup-1.8.0}/circup.egg-info/requires.txt

@@ -12,14 +12,14 @@ importlib_metadata
 [all]
 wheel
 pytest-faulthandler
-pytest-random-order>=1.0.0
+coverage
 pylint
 pytest
-coverage
-black
-pytest-cov
 twine
 sphinx
+black
+pytest-random-order>=1.0.0
+pytest-cov
 
 [dev]
 pytest