anaconda-cli-base 0.1.0__tar.gz

anaconda_cli_base-0.1.0/.gitignore

@@ -0,0 +1,46 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+env/
+build/
+develop-eggs/
+dist/
+*.egg-info
+
+# Unit test / coverage reports
+htmlcov/
+.coverage
+.coverage.*
+coverage.xml
+.pytest_cache/
+.tox/
+
+# Sphinx documentation
+docs/_build/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+
+# mypy
+.mypy_cache/
+
+# vscode ide stuff
+*.code-workspace
+.history
+.vscode
+
+# Version file generated by setuptools-scm
+/libs/*/src/*/_version.py
+
+# Stored tokens (for dev)
+/tokens.json

anaconda_cli_base-0.1.0/LICENSE

@@ -0,0 +1,27 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Anaconda, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the copyright holder nor the names of its
+      contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

anaconda_cli_base-0.1.0/Makefile

@@ -0,0 +1,28 @@
+# Conda-related paths
+conda_env_dir ?= ./env
+
+# Command aliases
+CONDA_EXE ?= conda
+CONDA_RUN := $(CONDA_EXE) run --prefix $(conda_env_dir) --no-capture-output
+
+help:  ## Display help on all Makefile targets
+	@@grep -h '^[a-zA-Z]' $(MAKEFILE_LIST) | awk -F ':.*?## ' 'NF==2 {printf "   %-20s%s\n", $$1, $$2}' | sort
+
+setup:  ## Setup local dev conda environment
+	$(CONDA_EXE) env $(shell [ -d $(conda_env_dir) ] && echo update || echo create) -p $(conda_env_dir) --file environment-dev.yml
+
+test:  ## Run all the unit tests
+	$(CONDA_RUN) pytest
+
+tox:  ## Run tox to test in isolated environments
+	$(CONDA_RUN) tox
+
+clean:  ## Clean up cache and temporary files
+	find . -name \*.py[cod] -delete
+	rm -rf .pytest_cache .mypy_cache .tox build dist
+
+clean-all: clean  ## Clean up, including build files and conda environment
+	find . -name \*.egg-info -delete
+	rm -rf $(conda_env_dir)
+
+.PHONY: $(MAKECMDGOALS)

anaconda_cli_base-0.1.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.1
+Name: anaconda-cli-base
+Version: 0.1.0
+Summary: A base CLI entrypoint supporting Anaconda CLI plugins
+License: BSD-3-Clause
+License-File: LICENSE
+Requires-Python: >=3.8
+Requires-Dist: readchar
+Requires-Dist: rich
+Requires-Dist: typer
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-mock; extra == 'dev'
+Requires-Dist: tox; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
+Provides-Extra: publish
+Requires-Dist: build; extra == 'publish'
+Requires-Dist: twine; extra == 'publish'
+Requires-Dist: wheel; extra == 'publish'
+Description-Content-Type: text/markdown
+
+# anaconda-cli-base
+
+A base CLI entrypoint supporting Anaconda CLI plugins
+
+## Registering plugins
+
+Subcommands can be registered as follows:
+
+```toml
+# In pyproject.toml
+
+[project.entry-points."anaconda_cli.subcommand"]
+auth = "anaconda_cloud_auth.cli:app"
+```
+
+In the example above:
+
+* `"anaconda_cloud_cli.subcommand"` is the required string to use for registration. The quotes are important.
+* `auth` is the name of the new subcommand, i.e. `anaconda auth`
+* `anaconda_cloud_auth.cli:app` signifies the object named `app` in the `anaconda_cloud_auth.cli` module is the entry point for the subcommand.
+
+
+## Setup for development
+
+Ensure you have `conda` installed.
+Then run:
+```shell
+make setup
+```
+
+## Run the unit tests
+```shell
+make test
+```
+
+## Run the unit tests across isolated environments with tox
+```shell
+make tox
+```

anaconda_cli_base-0.1.0/README.md

@@ -0,0 +1,39 @@
+# anaconda-cli-base
+
+A base CLI entrypoint supporting Anaconda CLI plugins
+
+## Registering plugins
+
+Subcommands can be registered as follows:
+
+```toml
+# In pyproject.toml
+
+[project.entry-points."anaconda_cli.subcommand"]
+auth = "anaconda_cloud_auth.cli:app"
+```
+
+In the example above:
+
+* `"anaconda_cloud_cli.subcommand"` is the required string to use for registration. The quotes are important.
+* `auth` is the name of the new subcommand, i.e. `anaconda auth`
+* `anaconda_cloud_auth.cli:app` signifies the object named `app` in the `anaconda_cloud_auth.cli` module is the entry point for the subcommand.
+
+
+## Setup for development
+
+Ensure you have `conda` installed.
+Then run:
+```shell
+make setup
+```
+
+## Run the unit tests
+```shell
+make test
+```
+
+## Run the unit tests across isolated environments with tox
+```shell
+make tox
+```

anaconda_cli_base-0.1.0/environment-dev.yml

@@ -0,0 +1,12 @@
+# Local dev conda dependencies
+channels:
+- defaults
+- conda-forge
+dependencies:
+- python=3.10
+- anaconda-client>=1.12.0
+- tox=3
+- tox-conda
+- pip
+- pip:
+    - "-e .[dev]"

anaconda_cli_base-0.1.0/pyproject.toml

@@ -0,0 +1,127 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling", "hatch-vcs>=0.3", "setuptools-scm>=7.1"]
+
+[project]
+dependencies = [
+  "rich",
+  "readchar",
+  "typer"
+]
+description = "A base CLI entrypoint supporting Anaconda CLI plugins"
+dynamic = ["version"]
+license = {text = "BSD-3-Clause"}
+name = "anaconda-cli-base"
+readme = "README.md"
+requires-python = ">=3.8"
+
+[project.entry-points."anaconda_cli.main"]
+anaconda = "anaconda_cli_base.cli:app"
+
+[project.optional-dependencies]
+dev = [
+  "mypy",
+  "pytest",
+  "pytest-mock",
+  "tox",
+  "types-requests"
+]
+publish = [
+  "build",
+  "twine",
+  "wheel"
+]
+
+[tool.distutils.bdist_wheel]
+universal = true
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/anaconda_cli_base/_version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "/src/anaconda_cli_base",
+  "/pyproject.toml",
+  "/tests",
+  "/Makefile",
+  "/environment-dev.yml"
+]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.version.raw-options]
+git_describe_command = "git describe --dirty --tags --long --match 'anaconda-cli-base-*'"
+root = "../.."
+
+[tool.isort]
+force_single_line = true
+profile = "black"
+
+[tool.mypy]
+disallow_untyped_defs = true
+files = [
+  "src/**/*.py",
+  "tests/**/*.py"
+]
+python_version = "3.8"
+
+[[tool.mypy.overrides]]
+ignore_missing_imports = true
+module = "rich_click.*"
+
+[tool.pytest.ini_options]
+markers = [
+  "integration: Integration tests requiring a browser"
+]
+norecursedirs = ["env", "envs", ".tox"]
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+envlist = py38,py39,py310,py311,mypy
+isolated_build = True
+
+[gh-actions]
+python =
+    3.8: py38, mypy
+    3.9: py39, mypy
+    3.10: py310, mypy
+    3.11: py311
+
+[testenv]
+deps =
+    mypy
+    pytest
+    pytest-mock
+conda_deps =
+    anaconda-client >=1.12.0
+conda_channels =
+    anaconda-cloud
+    defaults
+    conda-forge
+commands = pytest -m "not integration"
+
+[testenv:mypy]
+deps =
+    mypy
+    pytest
+    pytest-mock
+    types-requests
+    typer
+    rich
+commands = mypy
+"""
+
+[tool.vendoring]
+destination = "src/anaconda_cli_base/_vendor/"
+namespace = "anaconda_cli_base._vendor"
+patches-dir = "tools/vendoring/patches"
+protected-files = ["__init__.py", "requirements.txt"]
+requirements = "src/anaconda_cli_base/_vendor/requirements.txt"
+
+[tool.vendoring.license.directories]
+setuptools = "pkg_resources"
+
+[tool.vendoring.license.fallback-urls]
+readchar = "https://raw.githubusercontent.com/magmax/python-readchar/master/LICENCE"

anaconda_cli_base-0.1.0/src/anaconda_cli_base/__init__.py

@@ -0,0 +1,8 @@
+try:
+    from anaconda_cli_base._version import version as __version__
+except ImportError:  # pragma: nocover
+    __version__ = "unknown"
+
+from anaconda_cli_base.console import console
+
+__all__ = ["__version__", "console"]

anaconda_cli_base-0.1.0/src/anaconda_cli_base/_version.py

@@ -0,0 +1,4 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)

anaconda_cli_base-0.1.0/src/anaconda_cli_base/cli.py

@@ -0,0 +1,26 @@
+from typing import Optional
+
+import typer
+
+from anaconda_cli_base import __version__
+from anaconda_cli_base import console
+from anaconda_cli_base.plugins import load_registered_subcommands
+
+app = typer.Typer(add_completion=False, help="Welcome to the Anaconda CLI!")
+
+load_registered_subcommands(app)
+
+
+@app.callback(invoke_without_command=True, no_args_is_help=True)
+def main(
+    version: Optional[bool] = typer.Option(
+        None, "--version", help="Show version and exit."
+    )
+) -> None:
+    """Anaconda CLI."""
+    if version:
+        console.print(
+            f"Anaconda CLI, version [cyan]{__version__}[/cyan]",
+            style="bold green",
+        )
+        raise typer.Exit()

anaconda_cli_base-0.1.0/src/anaconda_cli_base/console.py

@@ -0,0 +1,51 @@
+from typing import List
+
+from readchar import key
+from readchar import readkey
+from rich.console import Console
+from rich.live import Live
+from rich.style import Style
+from rich.table import Table
+
+__all__ = ["console", "select_from_list"]
+
+SELECTED = Style(color="green", bold=True)
+
+console = Console()
+
+
+def _generate_table(header: str, rows: List[str], selected: int) -> Table:
+    table = Table(box=None)
+
+    table.add_column(header)
+
+    for i, row in enumerate(rows):
+        if i == selected:
+            style = SELECTED
+            value = f"* {row}"
+        else:
+            style = None
+            value = f"  {row}"
+        table.add_row(value, style=style)
+
+    return table
+
+
+def select_from_list(prompt: str, choices: List[str]) -> str:
+    """Dynamically select from a list of choices, by using the up/down keys."""
+    # inspired by https://github.com/Textualize/rich/discussions/1785#discussioncomment-1883808
+    items = choices.copy()
+
+    selected = 0
+    with Live(_generate_table(prompt, items, selected), auto_refresh=False) as live:
+        while ch := readkey():
+            if ch == key.UP or ch == "k":
+                selected = max(0, selected - 1)
+            if ch == key.DOWN or ch == "j":
+                selected = min(len(items) - 1, selected + 1)
+            if ch == key.ENTER:
+                live.stop()
+                return items[selected]
+            live.update(_generate_table(prompt, items, selected), refresh=True)
+
+    raise ValueError("Unreachable")

anaconda_cli_base-0.1.0/src/anaconda_cli_base/plugins.py

@@ -0,0 +1,34 @@
+import logging
+from importlib.metadata import entry_points
+from sys import version_info
+
+from typer import Typer
+from typer.models import DefaultPlaceholder
+
+log = logging.getLogger(__name__)
+
+PLUGIN_GROUP_NAME = "anaconda_cli.subcommand"
+
+
+def load_registered_subcommands(app: Typer) -> None:
+    """Load all subcommands from plugins."""
+    # The API was changed in Python 3.10, see https://docs.python.org/3/library/importlib.metadata.html#entry-points
+    if version_info.major == 3 and version_info.minor <= 9:
+        subcommand_entry_points = entry_points().get(PLUGIN_GROUP_NAME, [])
+    else:
+        subcommand_entry_points = entry_points().select(group=PLUGIN_GROUP_NAME)  # type: ignore
+
+    for subcommand_entry_point in subcommand_entry_points:
+        # Load the entry point and register it as a subcommand with the base CLI app
+        subcommand_app = subcommand_entry_point.load()  # type: ignore
+
+        # Allow plugins to disable this if they explicitly want to, but otherwise make True the default
+        if isinstance(subcommand_app.info.no_args_is_help, DefaultPlaceholder):
+            subcommand_app.info.no_args_is_help = True
+
+        app.add_typer(subcommand_app, name=subcommand_entry_point.name)  # type: ignore
+        log.debug(
+            "Loaded subcommand '%s' from '%s'",
+            subcommand_entry_point.name,  # type: ignore
+            subcommand_entry_point.value,  # type: ignore
+        )

anaconda_cli_base-0.1.0/tests/conftest.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING
+from typing import Callable
+
+import pytest
+from mypy_extensions import VarArg
+from typer.testing import CliRunner
+from typer.testing import Result
+
+from anaconda_cli_base.cli import app
+
+if TYPE_CHECKING:
+    from _pytest.monkeypatch import MonkeyPatch
+
+CLIInvoker = Callable[[VarArg(str)], Result]
+
+
+@pytest.fixture()
+def tmp_cwd(monkeypatch: MonkeyPatch, tmp_path: Path) -> Path:
+    """Create & return a temporary directory after setting current working directory to it."""
+    monkeypatch.chdir(tmp_path)
+    return tmp_path
+
+
+@pytest.fixture()
+def invoke_cli(tmp_cwd: Path) -> CLIInvoker:
+    """Returns a function, which can be used to call the CLI from within a temporary directory."""
+    runner = CliRunner()
+
+    def f(*args: str) -> Result:
+        return runner.invoke(app, args)
+
+    return f

anaconda_cli_base-0.1.0/tests/test_cli.py

@@ -0,0 +1,26 @@
+from typing import Tuple
+
+import pytest
+
+from anaconda_cli_base import __version__
+
+from .conftest import CLIInvoker
+
+
+@pytest.mark.parametrize(
+    "args",
+    [
+        pytest.param((), id="no-args"),
+        pytest.param(("--help",), id="--help"),
+    ],
+)
+def test_cli_help(invoke_cli: CLIInvoker, args: Tuple[str]) -> None:
+    result = invoke_cli(*args)
+    assert result.exit_code == 0
+    assert "Welcome to the Anaconda CLI!" in result.stdout
+
+
+def test_cli_version(invoke_cli: CLIInvoker) -> None:
+    result = invoke_cli("--version")
+    assert result.exit_code == 0
+    assert f"Anaconda CLI, version {__version__}" in result.stdout