crackerjack 0.14.9__tar.gz → 0.15.0__tar.gz

{crackerjack-0.14.9 → crackerjack-0.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crackerjack
-Version: 0.14.9
+Version: 0.15.0
 Summary: Default template for PDM package
 Keywords: black,ruff,mypy,creosote,refurb
 Author-Email: lesleslie <les@wedgwoodwebworks.com>
@@ -125,15 +125,17 @@ Crackerjack automatically installs and manages these pre-commit hooks:
 Crackerjack projects adhere to these guidelines:
 
 -   **Static Typing:** Use type hints consistently throughout your code.
+-   **Modern Type Hints:** Use the pipe operator (`|`) for union types (e.g., `Path | None` instead of `Optional[Path]`).
 -   **Explicit Naming:** Choose clear, descriptive names for classes, functions, variables, and other identifiers.
 -   **Markdown for Documentation:** Use Markdown (`.md`) for all documentation, READMEs, etc.
 -   **Pathlib:** Use `pathlib.Path` for handling file and directory paths instead of `os.path`.
--   **Consistent Imports:** Use `import typing as t` for type hinting.
+-   **Consistent Imports:** Use `import typing as t` for type hinting and prefix all typing references with `t.`.
+-   **Protocol-Based Design:** Use `t.Protocol` for interface definitions instead of abstract base classes.
 -   **Constants and Config:** Do not use all-caps for constants or configuration settings.
 -   **Path Parameters:** Functions that handle file operations should accept `pathlib.Path` objects as parameters.
 -   **Dependency Management:** Use PDM for dependency management, package building, and publishing.
 -   **Testing:** Use pytest as your testing framework.
--   **Python Version:** Crackerjack projects support the latest Python versions.
+-   **Python Version:** Crackerjack projects target Python 3.13+ and use the latest language features.
 -   **Clear Code:** Avoid overly complex code.
 -   **Modular:** Functions should do one thing well.
 
@@ -155,10 +157,48 @@ Crackerjack projects adhere to these guidelines:
 
 ## Usage
 
+### Command Line
+
 Run Crackerjack from the root of your Python project using:
 
     python -m crackerjack
 
+### Programmatic API
+
+You can also use Crackerjack programmatically in your Python code:
+
+```python
+import typing as t
+from pathlib import Path
+from rich.console import Console
+from crackerjack import create_crackerjack_runner
+
+# Create a custom options object
+class MyOptions:
+    def __init__(self):
+        self.commit = False
+        self.interactive = True
+        self.doc = False
+        self.no_config_updates = False
+        self.verbose = True
+        self.update_precommit = False
+        self.clean = True
+        self.test = True
+        self.publish = None
+        self.bump = "micro"
+        self.all = None
+
+# Create a Crackerjack runner with custom settings
+runner = create_crackerjack_runner(
+    console=Console(force_terminal=True),
+    pkg_path=Path.cwd(),
+    python_version="3.13"
+)
+
+# Run Crackerjack with your options
+runner.process(MyOptions())
+```
+
 
 ### Command-Line Options
 
@@ -244,6 +284,17 @@ This ensures your code meets all quality standards before submission.
 
 This project is licensed under the terms of the BSD 3-Clause license.
 
+## Architecture
+
+Crackerjack is designed with modern Python principles in mind:
+
+- **Factory Pattern:** Uses a factory function (`create_crackerjack_runner`) to create instances with proper dependency injection
+- **Protocol-Based Design:** Defines clear interfaces using `t.Protocol` for better flexibility and testability
+- **Dependency Injection:** Components can be easily replaced with custom implementations
+- **Separation of Concerns:** CLI interface is separate from core logic
+- **Type Safety:** Comprehensive type hints throughout the codebase
+- **Testability:** Designed to be easily testable with mock objects
+
 ## Acknowledgments
 
 -   **PDM:** For excellent dependency and virtual environment management.
@@ -251,14 +302,14 @@ This project is licensed under the terms of the BSD 3-Clause license.
 -   **pre-commit:** For the robust hook management system.
 -   **pytest:** For the flexible and powerful testing framework.
 -   **uv:** For greatly improving PDM speeds.
-- **bandit:** For finding security vulnerabilities.
-- **vulture:** for dead code detection.
-- **creosote:** For unused dependency detection.
-- **flynt:** For f-string conversion.
-- **codespell:** For spelling correction.
-- **autotyping:** For automatically adding type hints.
-- **refurb:** For code improvement suggestions.
-- **pyright:** For static type checking.
-- **Typer:** For the creation of the CLI.
+-   **bandit:** For finding security vulnerabilities.
+-   **vulture:** For dead code detection.
+-   **creosote:** For unused dependency detection.
+-   **flynt:** For f-string conversion.
+-   **codespell:** For spelling correction.
+-   **autotyping:** For automatically adding type hints.
+-   **refurb:** For code improvement suggestions.
+-   **pyright:** For static type checking.
+-   **Typer:** For the creation of the CLI.
 
 ---

{crackerjack-0.14.9 → crackerjack-0.15.0}/README.md

@@ -86,15 +86,17 @@ Crackerjack automatically installs and manages these pre-commit hooks:
 Crackerjack projects adhere to these guidelines:
 
 -   **Static Typing:** Use type hints consistently throughout your code.
+-   **Modern Type Hints:** Use the pipe operator (`|`) for union types (e.g., `Path | None` instead of `Optional[Path]`).
 -   **Explicit Naming:** Choose clear, descriptive names for classes, functions, variables, and other identifiers.
 -   **Markdown for Documentation:** Use Markdown (`.md`) for all documentation, READMEs, etc.
 -   **Pathlib:** Use `pathlib.Path` for handling file and directory paths instead of `os.path`.
--   **Consistent Imports:** Use `import typing as t` for type hinting.
+-   **Consistent Imports:** Use `import typing as t` for type hinting and prefix all typing references with `t.`.
+-   **Protocol-Based Design:** Use `t.Protocol` for interface definitions instead of abstract base classes.
 -   **Constants and Config:** Do not use all-caps for constants or configuration settings.
 -   **Path Parameters:** Functions that handle file operations should accept `pathlib.Path` objects as parameters.
 -   **Dependency Management:** Use PDM for dependency management, package building, and publishing.
 -   **Testing:** Use pytest as your testing framework.
--   **Python Version:** Crackerjack projects support the latest Python versions.
+-   **Python Version:** Crackerjack projects target Python 3.13+ and use the latest language features.
 -   **Clear Code:** Avoid overly complex code.
 -   **Modular:** Functions should do one thing well.
 
@@ -116,10 +118,48 @@ Crackerjack projects adhere to these guidelines:
 
 ## Usage
 
+### Command Line
+
 Run Crackerjack from the root of your Python project using:
 
     python -m crackerjack
 
+### Programmatic API
+
+You can also use Crackerjack programmatically in your Python code:
+
+```python
+import typing as t
+from pathlib import Path
+from rich.console import Console
+from crackerjack import create_crackerjack_runner
+
+# Create a custom options object
+class MyOptions:
+    def __init__(self):
+        self.commit = False
+        self.interactive = True
+        self.doc = False
+        self.no_config_updates = False
+        self.verbose = True
+        self.update_precommit = False
+        self.clean = True
+        self.test = True
+        self.publish = None
+        self.bump = "micro"
+        self.all = None
+
+# Create a Crackerjack runner with custom settings
+runner = create_crackerjack_runner(
+    console=Console(force_terminal=True),
+    pkg_path=Path.cwd(),
+    python_version="3.13"
+)
+
+# Run Crackerjack with your options
+runner.process(MyOptions())
+```
+
 
 ### Command-Line Options
 
@@ -205,6 +245,17 @@ This ensures your code meets all quality standards before submission.
 
 This project is licensed under the terms of the BSD 3-Clause license.
 
+## Architecture
+
+Crackerjack is designed with modern Python principles in mind:
+
+- **Factory Pattern:** Uses a factory function (`create_crackerjack_runner`) to create instances with proper dependency injection
+- **Protocol-Based Design:** Defines clear interfaces using `t.Protocol` for better flexibility and testability
+- **Dependency Injection:** Components can be easily replaced with custom implementations
+- **Separation of Concerns:** CLI interface is separate from core logic
+- **Type Safety:** Comprehensive type hints throughout the codebase
+- **Testability:** Designed to be easily testable with mock objects
+
 ## Acknowledgments
 
 -   **PDM:** For excellent dependency and virtual environment management.
@@ -212,14 +263,14 @@ This project is licensed under the terms of the BSD 3-Clause license.
 -   **pre-commit:** For the robust hook management system.
 -   **pytest:** For the flexible and powerful testing framework.
 -   **uv:** For greatly improving PDM speeds.
-- **bandit:** For finding security vulnerabilities.
-- **vulture:** for dead code detection.
-- **creosote:** For unused dependency detection.
-- **flynt:** For f-string conversion.
-- **codespell:** For spelling correction.
-- **autotyping:** For automatically adding type hints.
-- **refurb:** For code improvement suggestions.
-- **pyright:** For static type checking.
-- **Typer:** For the creation of the CLI.
+-   **bandit:** For finding security vulnerabilities.
+-   **vulture:** For dead code detection.
+-   **creosote:** For unused dependency detection.
+-   **flynt:** For f-string conversion.
+-   **codespell:** For spelling correction.
+-   **autotyping:** For automatically adding type hints.
+-   **refurb:** For code improvement suggestions.
+-   **pyright:** For static type checking.
+-   **Typer:** For the creation of the CLI.
 
 ---

crackerjack-0.15.0/crackerjack/__init__.py

@@ -0,0 +1,5 @@
+import typing as t
+
+from .crackerjack import Crackerjack, create_crackerjack_runner
+
+__all__: t.Sequence[str] = ["create_crackerjack_runner", "Crackerjack"]

{crackerjack-0.14.9 → crackerjack-0.15.0}/crackerjack/__main__.py

@@ -1,10 +1,9 @@
-import typing as t
 from enum import Enum
 
 import typer
 from pydantic import BaseModel, field_validator
 from rich.console import Console
-from crackerjack import crackerjack_it
+from crackerjack import create_crackerjack_runner
 
 console = Console(force_terminal=True)
 app = typer.Typer(
@@ -26,17 +25,17 @@ class Options(BaseModel):
     interactive: bool = False
     doc: bool = False
     no_config_updates: bool = False
-    publish: t.Optional[BumpOption] = None
-    bump: t.Optional[BumpOption] = None
+    publish: BumpOption | None = None
+    bump: BumpOption | None = None
     verbose: bool = False
     update_precommit: bool = False
     clean: bool = False
     test: bool = False
-    all: t.Optional[BumpOption] = None
+    all: BumpOption | None = None
 
     @classmethod
     @field_validator("publish", "bump", mode="before")
-    def validate_bump_options(cls, value: t.Optional[str]) -> t.Optional[BumpOption]:
+    def validate_bump_options(cls, value: str | None) -> BumpOption | None:
         if value is None:
             return None
         try:
@@ -92,10 +91,6 @@ cli_options = {
 }
 
 
-def create_options(**kwargs: t.Any) -> Options:
-    return Options(**kwargs)
-
-
 @app.command()
 def main(
     commit: bool = cli_options["commit"],
@@ -104,13 +99,13 @@ def main(
     no_config_updates: bool = cli_options["no_config_updates"],
     update_precommit: bool = cli_options["update_precommit"],
     verbose: bool = cli_options["verbose"],
-    publish: t.Optional[BumpOption] = cli_options["publish"],
-    all: t.Optional[BumpOption] = cli_options["all"],
-    bump: t.Optional[BumpOption] = cli_options["bump"],
+    publish: BumpOption | None = cli_options["publish"],
+    all: BumpOption | None = cli_options["all"],
+    bump: BumpOption | None = cli_options["bump"],
     clean: bool = cli_options["clean"],
     test: bool = cli_options["test"],
 ) -> None:
-    options = create_options(
+    options = Options(
         commit=commit,
         interactive=interactive,
         doc=doc,
@@ -123,7 +118,9 @@ def main(
         test=test,
         all=all,
     )
-    crackerjack_it(options)
+
+    runner = create_crackerjack_runner(console=console)
+    runner.process(options)
 
 
 if __name__ == "__main__":

{crackerjack-0.14.9 → crackerjack-0.15.0}/crackerjack/crackerjack.py

@@ -20,6 +20,28 @@ interactive_hooks = ("refurb", "bandit", "pyright")
 default_python_version = "3.13"
 
 
+@t.runtime_checkable
+class CommandRunner(t.Protocol):
+    def execute_command(
+        self, cmd: list[str], **kwargs: t.Any
+    ) -> subprocess.CompletedProcess[str]: ...
+
+
+@t.runtime_checkable
+class OptionsProtocol(t.Protocol):
+    commit: bool
+    interactive: bool
+    doc: bool
+    no_config_updates: bool
+    verbose: bool
+    update_precommit: bool
+    clean: bool
+    test: bool
+    publish: t.Any | None
+    bump: t.Any | None
+    all: t.Any | None
+
+
 @dataclass
 class CodeCleaner:
     console: Console
@@ -430,7 +452,7 @@ class Crackerjack:
         self.project_manager.pkg_name = self.pkg_name
         self.project_manager.pkg_dir = self.pkg_dir
 
-    def _update_project(self, options: t.Any) -> None:
+    def _update_project(self, options: OptionsProtocol) -> None:
         if not options.no_config_updates:
             self.project_manager.update_pkg_configs()
             result: CompletedProcess[str] = self.execute_command(
@@ -443,16 +465,16 @@ class Crackerjack:
                     "\n\n❌ PDM installation failed. Is PDM is installed? Run `pipx install pdm` and try again.\n\n"
                 )
 
-    def _update_precommit(self, options: t.Any) -> None:
+    def _update_precommit(self, options: OptionsProtocol) -> None:
         if self.pkg_path.stem == "crackerjack" and options.update_precommit:
             self.execute_command(["pre-commit", "autoupdate"])
 
-    def _run_interactive_hooks(self, options: t.Any) -> None:
+    def _run_interactive_hooks(self, options: OptionsProtocol) -> None:
         if options.interactive:
             for hook in interactive_hooks:
                 self.project_manager.run_interactive(hook)
 
-    def _clean_project(self, options: t.Any) -> None:
+    def _clean_project(self, options: OptionsProtocol) -> None:
         if options.clean:
             if self.pkg_dir:
                 self.code_cleaner.clean_files(self.pkg_dir)
@@ -461,7 +483,7 @@ class Crackerjack:
                 self.console.print("\nCleaning tests directory...\n")
                 self.code_cleaner.clean_files(tests_dir)
 
-    def _run_tests(self, options: t.Any) -> None:
+    def _run_tests(self, options: OptionsProtocol) -> None:
         if options.test:
             self.console.print("\n\nRunning tests...\n")
             test = ["pytest"]
@@ -477,13 +499,13 @@ class Crackerjack:
                 raise SystemExit(1)
             self.console.print("\n\n✅ Tests passed successfully!\n")
 
-    def _bump_version(self, options: t.Any) -> None:
+    def _bump_version(self, options: OptionsProtocol) -> None:
         for option in (options.publish, options.bump):
             if option:
                 self.execute_command(["pdm", "bump", option])
                 break
 
-    def _publish_project(self, options: t.Any) -> None:
+    def _publish_project(self, options: OptionsProtocol) -> None:
         if options.publish:
             if platform.system() == "Darwin":
                 authorize = self.execute_command(
@@ -504,7 +526,7 @@ class Crackerjack:
                 raise SystemExit(1)
             self.execute_command(["pdm", "publish", "--no-build"])
 
-    def _commit_and_push(self, options: t.Any) -> None:
+    def _commit_and_push(self, options: OptionsProtocol) -> None:
         if options.commit:
             commit_msg = input("\nCommit message: ")
             self.execute_command(
@@ -520,7 +542,7 @@ class Crackerjack:
             return CompletedProcess(cmd, 0, "", "")
         return execute(cmd, **kwargs)
 
-    def process(self, options: t.Any) -> None:
+    def process(self, options: OptionsProtocol) -> None:
         if options.all:
             options.clean = True
             options.test = True
@@ -536,7 +558,20 @@ class Crackerjack:
         self._bump_version(options)
         self._publish_project(options)
         self._commit_and_push(options)
-        self.console.print("\nCrackerjack complete!\n")
-
-
-crackerjack_it = Crackerjack().process
+        self.console.print("\n🍺 Crackerjack complete!\n")
+
+
+def create_crackerjack_runner(
+    console: Console | None = None,
+    our_path: Path | None = None,
+    pkg_path: Path | None = None,
+    python_version: str = default_python_version,
+    dry_run: bool = False,
+) -> Crackerjack:
+    return Crackerjack(
+        console=console or Console(force_terminal=True),
+        our_path=our_path or Path(__file__).parent,
+        pkg_path=pkg_path or Path.cwd(),
+        python_version=python_version,
+        dry_run=dry_run,
+    )

{crackerjack-0.14.9 → crackerjack-0.15.0}/crackerjack/pyproject.toml

@@ -149,7 +149,7 @@ pythonPlatform = "Darwin"
 
 [project]
 name = "crackerjack"
-version = "0.14.8"
+version = "0.14.9"
 description = "Default template for PDM package"
 requires-python = ">=3.13"
 readme = "README.md"

{crackerjack-0.14.9 → crackerjack-0.15.0}/pyproject.toml

@@ -168,7 +168,7 @@ pythonPlatform = "Darwin"
 
 [project]
 name = "crackerjack"
-version = "0.14.9"
+version = "0.15.0"
 description = "Default template for PDM package"
 requires-python = ">=3.13"
 readme = "README.md"

{crackerjack-0.14.9 → crackerjack-0.15.0}/tests/test_crackerjack.py

@@ -311,7 +311,7 @@ class TestCrackerjackProcess:
                                 mock_tests.assert_called_once()
                                 mock_publish.assert_called_once()
                                 mock_commit.assert_called_once()
-        mock_console_print.assert_any_call("\nCrackerjack complete!\n")
+        mock_console_print.assert_any_call("\n🍺 Crackerjack complete!\n")
 
     def test_process_with_all_option_sets_flags(
         self,

crackerjack-0.15.0/tests/test_crackerjack_runner.py

@@ -0,0 +1,126 @@
+import tempfile
+import typing as t
+from pathlib import Path
+from unittest.mock import MagicMock, patch
+
+import pytest
+from rich.console import Console
+from crackerjack import create_crackerjack_runner
+from crackerjack.crackerjack import Crackerjack
+
+
+class MockOptions:
+    def __init__(self, **kwargs: t.Any) -> None:
+        self.commit = kwargs.get("commit", False)
+        self.interactive = kwargs.get("interactive", False)
+        self.doc = kwargs.get("doc", False)
+        self.no_config_updates = kwargs.get("no_config_updates", False)
+        self.verbose = kwargs.get("verbose", False)
+        self.update_precommit = kwargs.get("update_precommit", False)
+        self.clean = kwargs.get("clean", False)
+        self.test = kwargs.get("test", False)
+        self.publish = kwargs.get("publish")
+        self.bump = kwargs.get("bump")
+        self.all = kwargs.get("all")
+
+
+def test_create_crackerjack_runner() -> None:
+    console = Console(force_terminal=False)
+    runner = create_crackerjack_runner(console=console)
+
+    assert isinstance(runner, Crackerjack)
+    assert runner.console == console
+    assert runner.our_path == Path(__file__).parent.parent / "crackerjack"
+    assert runner.pkg_path == Path.cwd()
+    assert not runner.dry_run
+
+
+@pytest.fixture
+def mock_crackerjack():
+    with tempfile.TemporaryDirectory() as tmp_dir:
+        tmp_path = Path(tmp_dir)
+        console = MagicMock(spec=Console)
+
+        with (
+            patch("crackerjack.crackerjack.CodeCleaner") as mock_cleaner,
+            patch("crackerjack.crackerjack.ConfigManager") as mock_config,
+            patch("crackerjack.crackerjack.ProjectManager") as mock_project,
+        ):
+            mock_cleaner_instance = mock_cleaner.return_value
+            mock_config_instance = mock_config.return_value
+            mock_project_instance = mock_project.return_value
+
+            crackerjack = Crackerjack(
+                our_path=tmp_path,
+                pkg_path=tmp_path,
+                console=console,
+                code_cleaner=mock_cleaner_instance,
+                config_manager=mock_config_instance,
+                project_manager=mock_project_instance,
+            )
+
+            yield (
+                crackerjack,
+                {
+                    "console": console,
+                    "code_cleaner": mock_cleaner_instance,
+                    "config_manager": mock_config_instance,
+                    "project_manager": mock_project_instance,
+                },
+            )
+
+
+def test_process_with_all_option(
+    mock_crackerjack: tuple[Crackerjack, dict[str, MagicMock]],
+) -> None:
+    crackerjack, mocks = mock_crackerjack
+
+    options = MockOptions(all="minor")
+
+    crackerjack.execute_command = MagicMock(return_value=MagicMock(returncode=0))
+
+    with patch("builtins.input", return_value="Test commit message"):
+        crackerjack.process(options)
+
+    assert options.clean is True
+    assert options.test is True
+    assert options.publish == "minor"
+    assert options.commit is True
+
+    mocks["project_manager"].run_pre_commit.assert_called_once()
+
+
+def test_process_with_clean_option(
+    mock_crackerjack: tuple[Crackerjack, dict[str, MagicMock]],
+) -> None:
+    crackerjack, mocks = mock_crackerjack
+
+    options = MockOptions(clean=True)
+
+    crackerjack.pkg_dir = crackerjack.pkg_path / "test_pkg"
+
+    crackerjack.execute_command = MagicMock(return_value=MagicMock(returncode=0))
+
+    with patch("builtins.input", return_value="Test commit message"):
+        crackerjack.process(options)
+
+    mocks["code_cleaner"].clean_files.assert_called_with(crackerjack.pkg_dir)
+
+
+def test_process_with_test_option(
+    mock_crackerjack: tuple[Crackerjack, dict[str, MagicMock]],
+) -> None:
+    crackerjack, _ = mock_crackerjack
+
+    options = MockOptions(test=True)
+
+    crackerjack.execute_command = MagicMock(
+        return_value=MagicMock(returncode=0, stdout="All tests passed", stderr="")
+    )
+
+    with patch("builtins.input", return_value="Test commit message"):
+        crackerjack.process(options)
+
+    crackerjack.execute_command.assert_any_call(
+        ["pytest"], capture_output=True, text=True
+    )

{crackerjack-0.14.9 → crackerjack-0.15.0}/tests/test_main.py

@@ -3,13 +3,16 @@ from unittest.mock import MagicMock, patch
 
 import pytest
 from typer.testing import CliRunner
-from crackerjack.__main__ import BumpOption, Options, app, create_options
+from crackerjack.__main__ import BumpOption, Options, app
 
 
 @pytest.fixture
 def mock_crackerjack_process() -> t.Generator[MagicMock, None, None]:
-    with patch("crackerjack.__main__.crackerjack_it") as mock_process:
-        yield mock_process
+    mock_runner = MagicMock()
+    mock_create = MagicMock(return_value=mock_runner)
+
+    with patch("crackerjack.__main__.create_crackerjack_runner", mock_create):
+        yield mock_runner
 
 
 @pytest.fixture
@@ -20,8 +23,8 @@ def runner() -> CliRunner:
 def test_no_options(runner: CliRunner, mock_crackerjack_process: MagicMock) -> None:
     result = runner.invoke(app)
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert isinstance(options, Options)
     assert not options.commit
     assert not options.interactive
@@ -38,13 +41,13 @@ def test_no_options(runner: CliRunner, mock_crackerjack_process: MagicMock) -> N
 def test_commit_option(runner: CliRunner, mock_crackerjack_process: MagicMock) -> None:
     result = runner.invoke(app, ["-c"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.commit
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--commit"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.commit
 
 
@@ -53,26 +56,26 @@ def test_interactive_option(
 ) -> None:
     result = runner.invoke(app, ["-i"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.interactive
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--interactive"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.interactive
 
 
 def test_doc_option(runner: CliRunner, mock_crackerjack_process: MagicMock) -> None:
     result = runner.invoke(app, ["-d"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.doc
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--doc"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.doc
 
 
@@ -81,85 +84,85 @@ def test_update_precommit_option(
 ) -> None:
     result = runner.invoke(app, ["-u"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.update_precommit
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--update-precommit"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.update_precommit
 
 
 def test_verbose_option(runner: CliRunner, mock_crackerjack_process: MagicMock) -> None:
     result = runner.invoke(app, ["-v"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.verbose
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--verbose"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.verbose
 
 
 def test_publish_option(runner: CliRunner, mock_crackerjack_process: MagicMock) -> None:
     result = runner.invoke(app, ["-p", "micro"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.publish == BumpOption.micro
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--publish", "minor"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.publish == BumpOption.minor
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--publish", "major"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.publish == BumpOption.major
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--publish", "MICRO"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.publish == BumpOption.micro
 
 
 def test_bump_option(runner: CliRunner, mock_crackerjack_process: MagicMock) -> None:
     result = runner.invoke(app, ["-b", "micro"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.bump == BumpOption.micro
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--bump", "minor"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.bump == BumpOption.minor
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--bump", "major"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.bump == BumpOption.major
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--bump", "MICRO"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.bump == BumpOption.micro
 
 
 def test_clean_option(runner: CliRunner, mock_crackerjack_process: MagicMock) -> None:
     result = runner.invoke(app, ["-x"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.clean
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--clean"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.clean
 
 
@@ -168,26 +171,26 @@ def test_no_config_updates(
 ) -> None:
     result = runner.invoke(app, ["-n"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.no_config_updates
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--no-config-updates"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.no_config_updates
 
 
 def test_test_option(runner: CliRunner, mock_crackerjack_process: MagicMock) -> None:
     result = runner.invoke(app, ["-t"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.test
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--test"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.test
 
 
@@ -196,8 +199,8 @@ def test_multiple_options(
 ) -> None:
     result = runner.invoke(app, ["-c", "-i", "-d", "-t", "-x"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.commit
     assert options.interactive
     assert options.doc
@@ -206,7 +209,7 @@ def test_multiple_options(
 
 
 def test_create_options() -> None:
-    test_options = create_options(
+    test_options = Options(
         commit=True,
         interactive=True,
         doc=True,
@@ -237,7 +240,7 @@ def test_conflicting_options(
 ) -> None:
     result = runner.invoke(app, ["-p", "micro", "-b", "minor"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.publish == BumpOption.micro
     assert options.bump == BumpOption.minor
 
@@ -245,23 +248,23 @@ def test_conflicting_options(
 def test_all_option(runner: CliRunner, mock_crackerjack_process: MagicMock) -> None:
     result = runner.invoke(app, ["-a", "micro"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.all == BumpOption.micro
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--all", "minor"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.all == BumpOption.minor
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--all", "major"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.all == BumpOption.major
-    mock_crackerjack_process.reset_mock()
+    mock_crackerjack_process.process.reset_mock()
     result = runner.invoke(app, ["--all", "MICRO"])
     assert result.exit_code == 0
-    options = mock_crackerjack_process.call_args[0][0]
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.all == BumpOption.micro
 
 
@@ -270,8 +273,8 @@ def test_all_option_with_other_options(
 ) -> None:
     result = runner.invoke(app, ["-a", "micro", "-c", "-t"])
     assert result.exit_code == 0
-    mock_crackerjack_process.assert_called_once()
-    options = mock_crackerjack_process.call_args[0][0]
+    mock_crackerjack_process.process.assert_called_once()
+    options = mock_crackerjack_process.process.call_args[0][0]
     assert options.all == BumpOption.micro
     assert options.commit
     assert options.test

crackerjack-0.14.9/crackerjack/__init__.py

@@ -1,5 +0,0 @@
-from typing import Sequence
-
-from .crackerjack import Crackerjack, crackerjack_it
-
-__all__: Sequence[str] = ["crackerjack_it", "Crackerjack"]