bonus-click 0.0.1__tar.gz

bonus_click-0.0.1/AUTHORS.md

@@ -0,0 +1,7 @@
+
+# Credits
+
+The following people have been involved in one way or another with this project.
+
+* Devon Bray <dev@esologic.com>
+

bonus_click-0.0.1/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Devon Bray
+
+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.

bonus_click-0.0.1/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: bonus_click
+Version: 0.0.1
+Summary: Convenience wrappers around helpful click patterns.
+License-File: AUTHORS.md
+License-File: LICENSE.md
+Author: Devon Bray
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: click (>=8.3.0,<9.0.0)
+Description-Content-Type: text/markdown
+
+# Bonus Click - `bonus_click` 
+
+![](./logo.jpeg)
+
+Convenience wrappers around helpful [click](https://click.palletsprojects.com/en/stable/) patterns.
+
+## Getting Started
+
+### Python Dependencies
+
+Poetry is required to manage Python dependencies. You can install it easily by following the
+operating system specific instructions [here](https://python-poetry.org/docs/#installation).
+
+`pyproject.toml` contains dependencies for required Python modules for building, testing, and 
+developing. They can all be installed in a [virtual environment](https://docs.python.org/3/library/venv.html) 
+using the follow commands:
+
+```
+python3.10 -m venv .venv
+source ./.venv/bin/activate
+poetry install
+```
+
+There's also a bin script to do this, and will install poetry if you don't already have it:
+
+```
+./tools/create_venv.sh
+```
+
+## Developer Guide
+
+The following is documentation for developers that would like to contribute
+to Bonus Click.
+
+### Testing
+
+This project uses pytest to manage and run unit tests. Unit tests located in the `test` directory 
+are automatically run during the CI build. You can run them manually with:
+
+```
+./tools/run_tests.sh
+```
+
+### Local Linting
+
+There are a few linters/code checks included with this project to speed up the development process:
+
+* Black - An automatic code formatter, never think about python style again.
+* Isort - Automatically organizes imports in your modules.
+* Pylint - Check your code against many of the python style guide rules.
+* Mypy - Check your code to make sure it is properly typed.
+
+You can run these tools automatically in check mode, meaning you will get an error if any of them
+would not pass with:
+
+```
+./tools/run_checks.sh
+```
+
+Or actually automatically apply the fixes with:
+
+```
+./tools/apply_linters.sh
+```
+
+There are also scripts in `./tools/` that include run/check for each individual tool.
+
+
+### Using pre-commit
+
+Upon cloning the repo, to use pre-commit, you'll need to install the hooks with:
+
+```
+pre-commit install --hook-type pre-commit --hook-type pre-push
+```
+
+By default:
+
+* black
+* pylint
+* isort
+* mypy
+
+Are all run in apply-mode and must pass in order to actually make the commit.
+
+Also by default, pytest needs to pass before you can push.
+
+If you'd like skip these checks you can commit with:
+
+```
+git commit --no-verify
+```
+
+If you'd like to quickly run these pre-commit checks on all files (not just the staged ones) you
+can run:
+
+```
+pre-commit run --all-files
+```
+
+
+

bonus_click-0.0.1/README.md

@@ -0,0 +1,101 @@
+# Bonus Click - `bonus_click` 
+
+![](./logo.jpeg)
+
+Convenience wrappers around helpful [click](https://click.palletsprojects.com/en/stable/) patterns.
+
+## Getting Started
+
+### Python Dependencies
+
+Poetry is required to manage Python dependencies. You can install it easily by following the
+operating system specific instructions [here](https://python-poetry.org/docs/#installation).
+
+`pyproject.toml` contains dependencies for required Python modules for building, testing, and 
+developing. They can all be installed in a [virtual environment](https://docs.python.org/3/library/venv.html) 
+using the follow commands:
+
+```
+python3.10 -m venv .venv
+source ./.venv/bin/activate
+poetry install
+```
+
+There's also a bin script to do this, and will install poetry if you don't already have it:
+
+```
+./tools/create_venv.sh
+```
+
+## Developer Guide
+
+The following is documentation for developers that would like to contribute
+to Bonus Click.
+
+### Testing
+
+This project uses pytest to manage and run unit tests. Unit tests located in the `test` directory 
+are automatically run during the CI build. You can run them manually with:
+
+```
+./tools/run_tests.sh
+```
+
+### Local Linting
+
+There are a few linters/code checks included with this project to speed up the development process:
+
+* Black - An automatic code formatter, never think about python style again.
+* Isort - Automatically organizes imports in your modules.
+* Pylint - Check your code against many of the python style guide rules.
+* Mypy - Check your code to make sure it is properly typed.
+
+You can run these tools automatically in check mode, meaning you will get an error if any of them
+would not pass with:
+
+```
+./tools/run_checks.sh
+```
+
+Or actually automatically apply the fixes with:
+
+```
+./tools/apply_linters.sh
+```
+
+There are also scripts in `./tools/` that include run/check for each individual tool.
+
+
+### Using pre-commit
+
+Upon cloning the repo, to use pre-commit, you'll need to install the hooks with:
+
+```
+pre-commit install --hook-type pre-commit --hook-type pre-push
+```
+
+By default:
+
+* black
+* pylint
+* isort
+* mypy
+
+Are all run in apply-mode and must pass in order to actually make the commit.
+
+Also by default, pytest needs to pass before you can push.
+
+If you'd like skip these checks you can commit with:
+
+```
+git commit --no-verify
+```
+
+If you'd like to quickly run these pre-commit checks on all files (not just the staged ones) you
+can run:
+
+```
+pre-commit run --all-files
+```
+
+

bonus_click-0.0.1/bonus_click/__init__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+
+"""Top-level package for Bonus Click."""
+
+__author__ = """Devon Bray"""
+__email__ = "dev@esologic.com"

bonus_click-0.0.1/bonus_click/_options/enum_option.py

@@ -0,0 +1,85 @@
+"""
+Uses enums to define different choices the user can make in your CLI.
+"""
+
+from enum import Enum
+from typing import Callable, Optional, TypeVar
+
+import click
+from click import Context, Parameter
+from click.decorators import FC
+
+# A generic type variable for Enum subclasses, essentially any enum subclass.
+E = TypeVar("E", bound=Enum)
+T = TypeVar("T")
+
+
+def create_enum_option(  # pylint: disable=too-many-positional-arguments
+    arg_flag: str,
+    help_message: str,
+    default: E,
+    input_enum: type[E],
+    lookup_fn: Optional[Callable[[E], T]] = None,
+    envvar: Optional[str] = None,
+) -> Callable[[FC], FC]:
+    """
+    Creates a Click option for an Enum type. Resulting input can be given as an index or as the
+    string value from the enum.
+
+    :param arg_flag: The argument flag for the Click option (e.g., "--output").
+    :param help_message: Will be included in the --help message alongside the acceptable inputs
+    to the Enum.
+    :param default: The default value for the Click option, must be a member of `input_enum`.
+    :param lookup_fn: If given, the resolved value will be passed to this function, then the click
+    command will get whatever is returned as an argument.
+    :param input_enum: The Enum class from which the option values are derived.
+    :param envvar: Passed to the click option.
+    :return: A Click option configured for the specified Enum.
+    """
+
+    try:
+        input_enum(default)
+    except ValueError as e:
+        raise ValueError("Default value was not a member of the enum!") from e
+
+    options_string = "\n".join(
+        [f"   {idx}: {enum_member.value}" for idx, enum_member in enumerate(input_enum)]
+    )
+
+    help_string = (
+        f"\b\n{help_message}\nOptions below. Either provide index or value:\n{options_string}"
+    )
+
+    def callback(_ctx: Context, _param: Parameter, value: str) -> "T | E":
+        enum_options = list(input_enum)
+        try:
+            # Try interpreting as an index
+            index = int(value)
+            if 0 <= index < len(enum_options):
+                return enum_options[index]
+            else:
+                raise click.BadParameter(
+                    f"Index out of range. Valid range: 0-{len(enum_options)-1}."
+                )
+        except ValueError:
+            # If not an index, validate as a string
+            try:
+                resolved: E = input_enum(value)
+                return lookup_fn(resolved) if lookup_fn else resolved
+            except ValueError as e:
+                valid_choices = ", ".join([e.value for e in enum_options])
+                raise click.BadParameter(
+                    "Invalid choice. "
+                    f"Valid names: {valid_choices}, or indices 0-{len(enum_options)-1}."
+                ) from e
+
+    return click.option(
+        arg_flag,
+        type=click.STRING,
+        callback=callback,
+        help=help_string,
+        default=default.value,  # Ensure we use the string value for the default
+        show_default=True,
+        envvar=envvar,
+        show_envvar=True,
+    )

bonus_click-0.0.1/bonus_click/options.py

@@ -0,0 +1,9 @@
+"""
+Exposes the set of custom click options implemented in the project.
+"""
+
+# pylint: disable=protected-access
+
+from bonus_click._options.enum_option import create_enum_option
+
+__all__ = ["create_enum_option"]

bonus_click-0.0.1/pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core"]
+
+[tool.black]
+line-length = 100
+target-version = ['py310']
+
+[tool.isort]
+extra_standard_library = "setuptools,typing_extensions"
+force_grid_wrap = 0
+include_trailing_comma = true
+line_length = 100
+multi_line_output = 3
+skip = ["/home/circleci/repo/venv", "./venv", "./.venv"]
+use_parentheses = true
+
+[tool.mypy]
+allow_redefinition = false
+check_untyped_defs = true
+disallow_any_explicit = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_defs = true
+ignore_missing_imports = true
+mypy_path = ".:test:bonus_click"
+no_implicit_optional = true
+scripts_are_modules = true
+strict_optional = false
+warn_incomplete_stub = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_ignores = true
+
+[tool.poetry]
+authors = ["Devon Bray"]
+description = "Convenience wrappers around helpful click patterns."
+name = "bonus_click"
+readme = "README.md"
+version = "0.0.1"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+click = "^8.3.0"
+
+[tool.poetry.group.dev.dependencies]
+black = "*"
+isort = "*"
+mypy = "*"
+pre-commit = "*"
+pylint = "*"
+pydevd-pycharm = ">=231.8109.197,<231.8110.0"
+wheel = "^0.38"
+
+[tool.poetry.group.test.dependencies]
+coverage = "*"
+pytest = "*"
+pytest-cov = "*"
+
+[tool.pytest.ini_options]
+addopts = "-rsxX --showlocals --strict-markers"
+
+[tool.pytest.ini_options.markers]
+devtest = "temporary development mark that can be used as needed (should not be merged to master)"
+integration = "tests that access outside services (s3, APIs), don't run in CircleCI"
+timeout = "timeout for test in seconds, from `pytest-timeout` module"