crackerjack 0.12.0__tar.gz → 0.13.0__tar.gz

{crackerjack-0.12.0 → crackerjack-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crackerjack
-Version: 0.12.0
+Version: 0.13.0
 Summary: Default template for PDM package
 Keywords: black,ruff,mypy,creosote,refurb
 Author-Email: lesleslie <les@wedgwoodwebworks.com>
@@ -52,6 +52,31 @@ Description-Content-Type: text/markdown
 
 Crackerjack is an opinionated Python project management tool designed to help you create, maintain, and publish high-quality Python projects with ease. It combines best-in-class tools and a streamlined workflow to ensure code quality, consistency, and reliability.
 
+---
+
+## Getting Started
+
+### Quick Start
+
+If you're new to Crackerjack, follow these steps:
+1. **Install Python 3.13:** Ensure you have Python 3.13 installed.
+2. **Install PDM:**
+    ```
+    pipx install pdm
+    ```
+3. **Install Crackerjack:**
+    ```
+    pip install crackerjack
+    ```
+
+4. **Initialize a New Project:**
+    Navigate to your project's root directory and run:
+    ```
+    python -m crackerjack
+    ```
+
+---
+
 ## The Crackerjack Philosophy
 
 Crackerjack is built on the following core principles:
@@ -61,7 +86,7 @@ Crackerjack is built on the following core principles:
 -   **Consistency:** Code style, formatting, and project structure should be consistent across projects.
 -   **Reliability:** Tests are essential, and code should be checked rigorously.
 -   **Tool Integration:** Leverage powerful existing tools instead of reinventing the wheel.
-- **Static Typing:** Static typing is essential for all development.
+-   **Static Typing:** Static typing is essential for all development.
 
 ## Key Features
 
@@ -76,7 +101,7 @@ Crackerjack provides:
 -   **Built-in Testing:** Automatically runs tests using `pytest`.
 -   **Easy Version Bumping:** Provides commands to bump the project version (micro, minor, or major).
 -   **Simplified Publishing:** Automates publishing to PyPI via PDM.
-- **Commit and Push:** Commits and pushes your changes.
+-   **Commit and Push:** Commits and pushes your changes.
 
 ## Pre-commit Hooks
 
@@ -101,7 +126,7 @@ Crackerjack projects adhere to these guidelines:
 
 -   **Static Typing:** Use type hints consistently throughout your code.
 -   **Explicit Naming:** Choose clear, descriptive names for classes, functions, variables, and other identifiers.
--   **Markdown for Documentation:** Use Markdown (`.md`) for all documentation, including docstrings, READMEs, etc.
+-   **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.
 -   **Constants and Config:** Do not use all-caps for constants or configuration settings.
@@ -141,12 +166,14 @@ Run Crackerjack from the root of your Python project using:
 -   `-i`, `--interactive`: Run pre-commit hooks interactively when possible.
 -   `-n`, `--no-config-updates`: Skip updating configuration files (e.g., `pyproject.toml`).
 -   `-u`, `--update-precommit`: Update pre-commit hooks to the latest versions.
--   `-v`, `--verbose`: Enable verbose output.
+-   `-d`, `--doc`: Generate documentation.  (not yet implemented)
+-   `-v`, `--verbose`: Enable verbose output. (not yet implemented)
 -   `-p`, `--publish <micro|minor|major>`: Bump the project version and publish to PyPI using PDM.
 -   `-b`, `--bump <micro|minor|major>`: Bump the project version without publishing.
 -   `-x`, `--clean`: Clean code by removing docstrings, line comments, and extra whitespace.
 -   `-t`, `--test`: Run tests using `pytest`.
--   `-h`, `--help`: Display help.
+-   `-a`, `--all`: Run with `-x -t -p <micro|minor|major> -c` development options.
+-   `--help`: Display help.
 
 ### Example Workflows
 
@@ -156,7 +183,7 @@ Run Crackerjack from the root of your Python project using:
     ```
 
 -   **Clean code, run checks, run tests, then commit:**
-    ````
+    ```
     python -m crackerjack -c -x -t
     ```
 
@@ -174,15 +201,27 @@ Run Crackerjack from the root of your Python project using:
     ```
     python -m crackerjack -b major
     ```
+
 - **Update pre-commit hooks:**
     ```
     python -m crackerjack -u
     ```
+
 - **Get help:**
     ```
-    python -m crackerjack -h
+    python -m crackerjack --help
     ```
 
+- **Clean code, run checks, run tests, bump version, publish, then commit:**
+    ```
+  python -m crackerjack -x -t -p minor -c
+
+  # or even easier
+
+  python -m crackerjack -a minor
+  ```
+
+
 ## Contributing
 
 Crackerjack is an evolving project. Contributions are welcome! Please open a pull request or issue.

{crackerjack-0.12.0 → crackerjack-0.13.0}/README.md

@@ -13,6 +13,31 @@
 
 Crackerjack is an opinionated Python project management tool designed to help you create, maintain, and publish high-quality Python projects with ease. It combines best-in-class tools and a streamlined workflow to ensure code quality, consistency, and reliability.
 
+---
+
+## Getting Started
+
+### Quick Start
+
+If you're new to Crackerjack, follow these steps:
+1. **Install Python 3.13:** Ensure you have Python 3.13 installed.
+2. **Install PDM:**
+    ```
+    pipx install pdm
+    ```
+3. **Install Crackerjack:**
+    ```
+    pip install crackerjack
+    ```
+
+4. **Initialize a New Project:**
+    Navigate to your project's root directory and run:
+    ```
+    python -m crackerjack
+    ```
+
+---
+
 ## The Crackerjack Philosophy
 
 Crackerjack is built on the following core principles:
@@ -22,7 +47,7 @@ Crackerjack is built on the following core principles:
 -   **Consistency:** Code style, formatting, and project structure should be consistent across projects.
 -   **Reliability:** Tests are essential, and code should be checked rigorously.
 -   **Tool Integration:** Leverage powerful existing tools instead of reinventing the wheel.
-- **Static Typing:** Static typing is essential for all development.
+-   **Static Typing:** Static typing is essential for all development.
 
 ## Key Features
 
@@ -37,7 +62,7 @@ Crackerjack provides:
 -   **Built-in Testing:** Automatically runs tests using `pytest`.
 -   **Easy Version Bumping:** Provides commands to bump the project version (micro, minor, or major).
 -   **Simplified Publishing:** Automates publishing to PyPI via PDM.
-- **Commit and Push:** Commits and pushes your changes.
+-   **Commit and Push:** Commits and pushes your changes.
 
 ## Pre-commit Hooks
 
@@ -62,7 +87,7 @@ Crackerjack projects adhere to these guidelines:
 
 -   **Static Typing:** Use type hints consistently throughout your code.
 -   **Explicit Naming:** Choose clear, descriptive names for classes, functions, variables, and other identifiers.
--   **Markdown for Documentation:** Use Markdown (`.md`) for all documentation, including docstrings, READMEs, etc.
+-   **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.
 -   **Constants and Config:** Do not use all-caps for constants or configuration settings.
@@ -102,12 +127,14 @@ Run Crackerjack from the root of your Python project using:
 -   `-i`, `--interactive`: Run pre-commit hooks interactively when possible.
 -   `-n`, `--no-config-updates`: Skip updating configuration files (e.g., `pyproject.toml`).
 -   `-u`, `--update-precommit`: Update pre-commit hooks to the latest versions.
--   `-v`, `--verbose`: Enable verbose output.
+-   `-d`, `--doc`: Generate documentation.  (not yet implemented)
+-   `-v`, `--verbose`: Enable verbose output. (not yet implemented)
 -   `-p`, `--publish <micro|minor|major>`: Bump the project version and publish to PyPI using PDM.
 -   `-b`, `--bump <micro|minor|major>`: Bump the project version without publishing.
 -   `-x`, `--clean`: Clean code by removing docstrings, line comments, and extra whitespace.
 -   `-t`, `--test`: Run tests using `pytest`.
--   `-h`, `--help`: Display help.
+-   `-a`, `--all`: Run with `-x -t -p <micro|minor|major> -c` development options.
+-   `--help`: Display help.
 
 ### Example Workflows
 
@@ -117,7 +144,7 @@ Run Crackerjack from the root of your Python project using:
     ```
 
 -   **Clean code, run checks, run tests, then commit:**
-    ````
+    ```
     python -m crackerjack -c -x -t
     ```
 
@@ -135,15 +162,27 @@ Run Crackerjack from the root of your Python project using:
     ```
     python -m crackerjack -b major
     ```
+
 - **Update pre-commit hooks:**
     ```
     python -m crackerjack -u
     ```
+
 - **Get help:**
     ```
-    python -m crackerjack -h
+    python -m crackerjack --help
     ```
 
+- **Clean code, run checks, run tests, bump version, publish, then commit:**
+    ```
+  python -m crackerjack -x -t -p minor -c
+
+  # or even easier
+
+  python -m crackerjack -a minor
+  ```
+
+
 ## Contributing
 
 Crackerjack is an evolving project. Contributions are welcome! Please open a pull request or issue.

{crackerjack-0.12.0 → crackerjack-0.13.0}/crackerjack/__main__.py

@@ -31,6 +31,7 @@ class Options(BaseModel):
     update_precommit: bool = False
     clean: bool = False
     test: bool = False
+    all: t.Optional[BumpOption] = None
 
     @classmethod
     @field_validator("publish", "bump", mode="before")
@@ -80,6 +81,13 @@ cli_options = {
         help="Remove docstrings, line comments, and unnecessary whitespace.",
     ),
     "test": typer.Option(False, "-t", "--test", help="Run tests."),
+    "all": typer.Option(
+        None,
+        "-a",
+        "--all",
+        help="Run with `-x -t -p <micro|minor|major> -c` development options).",
+        case_sensitive=False,
+    ),
 }
 
 
@@ -96,6 +104,7 @@ def main(
     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"],
     clean: bool = cli_options["clean"],
     test: bool = cli_options["test"],
@@ -111,6 +120,7 @@ def main(
         bump=bump,
         clean=clean,
         test=test,
+        all=all,
     )
     crackerjack_it(options)
 

{crackerjack-0.12.0 → crackerjack-0.13.0}/crackerjack/crackerjack.py

@@ -1,4 +1,5 @@
 import ast
+import platform
 import re
 import subprocess
 import typing as t
@@ -367,11 +368,10 @@ class Crackerjack(BaseModel, arbitrary_types_allowed=True):
         if options.clean:
             if self.pkg_dir:
                 self.code_cleaner.clean_files(self.pkg_dir)
-            if self.pkg_path.stem == "crackerjack":
-                tests_dir = self.pkg_path / "tests"
-                if tests_dir.exists() and tests_dir.is_dir():
-                    self.console.print("\nCleaning tests directory...\n")
-                    self.code_cleaner.clean_files(tests_dir)
+            tests_dir = self.pkg_path / "tests"
+            if tests_dir.exists() and tests_dir.is_dir():
+                self.console.print("\nCleaning tests directory...\n")
+                self.code_cleaner.clean_files(tests_dir)
 
     def _run_tests(self, options: t.Any) -> None:
         if options.test:
@@ -394,6 +394,15 @@ class Crackerjack(BaseModel, arbitrary_types_allowed=True):
 
     def _publish_project(self, options: t.Any) -> None:
         if options.publish:
+            if platform.system() == "Darwin":
+                authorize = self.execute_command(
+                    ["pdm", "self", "add", "keyring"], capture_output=True, text=True
+                )
+                if authorize.returncode > 0:
+                    self.console.print(
+                        "\n\nAuthorization failed. Please add your keyring credentials to PDM. Run `pdm self add keyring` and try again.\n\n"
+                    )
+                    raise SystemExit(1)
             build = self.execute_command(
                 ["pdm", "build"], capture_output=True, text=True
             )
@@ -421,6 +430,11 @@ class Crackerjack(BaseModel, arbitrary_types_allowed=True):
         return execute(cmd, **kwargs)
 
     def process(self, options: t.Any) -> None:
+        if options.all:
+            options.clean = True
+            options.test = True
+            options.publish = options.all
+            options.commit = True
         self._setup_package()
         self._update_project(options)
         self._update_precommit(options)

{crackerjack-0.12.0 → crackerjack-0.13.0}/crackerjack/pyproject.toml

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

{crackerjack-0.12.0 → crackerjack-0.13.0}/pyproject.toml

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

crackerjack-0.13.0/tests/data/comments_sample.txt

@@ -0,0 +1,7 @@
+def test_func():
+    # This comment should be removed
+    return True  # remove this inline comment
+
+# Full line comment
+x = 1  # type: ignore
+y = 2  # noqa

crackerjack-0.13.0/tests/data/docstrings_sample.txt

@@ -0,0 +1,10 @@
+"""def test_func():
+    \"\"\"This is a docstring.\"\"\"
+    return True
+
+class TestClass:
+    \"\"\"Class docstring.\"\"\"
+    def method(self):
+        \"\"\"Method docstring.\"\"\"
+        pass
+"""