crackerjack 0.17.0__tar.gz → 0.17.2__tar.gz

{crackerjack-0.17.0 → crackerjack-0.17.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crackerjack
-Version: 0.17.0
+Version: 0.17.2
 Summary: Default template for PDM package
 Keywords: black,ruff,mypy,creosote,refurb
 Author-Email: lesleslie <les@wedgwoodwebworks.com>
@@ -28,14 +28,14 @@ Requires-Dist: pytest>=8.3.5
 Requires-Dist: pydantic>=2.11.4
 Requires-Dist: pdm-bump>=0.9.12
 Requires-Dist: pdm>=2.24.1
-Requires-Dist: uv>=0.7.2
+Requires-Dist: uv>=0.7.3
 Requires-Dist: pytest-cov>=6.1.1
 Requires-Dist: pytest-mock>=3.14.0
 Requires-Dist: tomli-w>=1.2.0
 Requires-Dist: pytest-asyncio>=0.26.0
 Requires-Dist: rich>=14.0.0
 Requires-Dist: typer>=0.15.3
-Requires-Dist: pytest-timeout>=2.3.1
+Requires-Dist: pytest-timeout>=2.4.0
 Description-Content-Type: text/markdown
 
 # Crackerjack: Elevate Your Python Development
@@ -51,7 +51,20 @@ Description-Content-Type: text/markdown
 
 **Crackerjack** (`ˈkra-kər-ˌjak`): *a person or thing of marked excellence.*
 
-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.
+## What is Crackerjack?
+
+Crackerjack is an opinionated Python project management tool designed to solve common challenges in Python development:
+
+- **Problem**: Setting up Python projects with best practices is time-consuming and requires knowledge of many tools
+- **Solution**: Crackerjack automates project setup with pre-configured best practices and tools
+
+- **Problem**: Maintaining consistent code quality across a project is difficult
+- **Solution**: Crackerjack enforces a consistent style and quality standard through integrated linting, formatting, and pre-commit hooks
+
+- **Problem**: Publishing Python packages involves many manual steps
+- **Solution**: Crackerjack streamlines the entire development lifecycle from code cleaning to testing to version bumping to publishing
+
+Crackerjack combines best-in-class tools (Ruff, PDM, pre-commit, pytest, and more) into a single, streamlined workflow to ensure code quality, consistency, and reliability. It's designed for Python developers who want to focus on writing code rather than configuring tools.
 
 ---
 
@@ -217,6 +230,7 @@ runner.process(MyOptions())
 -   `-x`, `--clean`: Clean code by removing docstrings, line comments, and extra whitespace.
 -   `-t`, `--test`: Run tests using `pytest`.
 -   `-a`, `--all`: Run with `-x -t -p <micro|minor|major> -c` development options.
+-   `--ai-agent`: Enable AI agent mode with structured output (see [AI Agent Integration](#ai-agent-integration)).
 -   `--help`: Display help.
 
 ### Example Workflows
@@ -270,6 +284,21 @@ runner.process(MyOptions())
   python -m crackerjack -a minor
   ```
 
+## AI Agent Integration
+
+Crackerjack includes special features for integration with AI agents like Claude, ChatGPT, and other LLM-based assistants:
+
+- **Structured JSON Output:** When run with `--ai-agent`, Crackerjack outputs results in JSON format that's easy for AI agents to parse
+- **Clear Status Indicators:** Provides clear status indicators (running, success, failed, complete) to track progress
+- **Action Tracking:** Includes a list of actions performed to help AI agents understand what happened
+
+### Example AI Agent Usage
+
+```bash
+python -m crackerjack --ai-agent --test
+```
+
+For detailed information about using Crackerjack with AI agents, including the structured output format and programmatic usage, see [README-AI-AGENT.md](README-AI-AGENT.md).
 
 ## Contributing
 

{crackerjack-0.17.0 → crackerjack-0.17.2}/README.md

@@ -11,7 +11,20 @@
 
 **Crackerjack** (`ˈkra-kər-ˌjak`): *a person or thing of marked excellence.*
 
-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.
+## What is Crackerjack?
+
+Crackerjack is an opinionated Python project management tool designed to solve common challenges in Python development:
+
+- **Problem**: Setting up Python projects with best practices is time-consuming and requires knowledge of many tools
+- **Solution**: Crackerjack automates project setup with pre-configured best practices and tools
+
+- **Problem**: Maintaining consistent code quality across a project is difficult
+- **Solution**: Crackerjack enforces a consistent style and quality standard through integrated linting, formatting, and pre-commit hooks
+
+- **Problem**: Publishing Python packages involves many manual steps
+- **Solution**: Crackerjack streamlines the entire development lifecycle from code cleaning to testing to version bumping to publishing
+
+Crackerjack combines best-in-class tools (Ruff, PDM, pre-commit, pytest, and more) into a single, streamlined workflow to ensure code quality, consistency, and reliability. It's designed for Python developers who want to focus on writing code rather than configuring tools.
 
 ---
 
@@ -177,6 +190,7 @@ runner.process(MyOptions())
 -   `-x`, `--clean`: Clean code by removing docstrings, line comments, and extra whitespace.
 -   `-t`, `--test`: Run tests using `pytest`.
 -   `-a`, `--all`: Run with `-x -t -p <micro|minor|major> -c` development options.
+-   `--ai-agent`: Enable AI agent mode with structured output (see [AI Agent Integration](#ai-agent-integration)).
 -   `--help`: Display help.
 
 ### Example Workflows
@@ -230,6 +244,21 @@ runner.process(MyOptions())
   python -m crackerjack -a minor
   ```
 
+## AI Agent Integration
+
+Crackerjack includes special features for integration with AI agents like Claude, ChatGPT, and other LLM-based assistants:
+
+- **Structured JSON Output:** When run with `--ai-agent`, Crackerjack outputs results in JSON format that's easy for AI agents to parse
+- **Clear Status Indicators:** Provides clear status indicators (running, success, failed, complete) to track progress
+- **Action Tracking:** Includes a list of actions performed to help AI agents understand what happened
+
+### Example AI Agent Usage
+
+```bash
+python -m crackerjack --ai-agent --test
+```
+
+For detailed information about using Crackerjack with AI agents, including the structured output format and programmatic usage, see [README-AI-AGENT.md](README-AI-AGENT.md).
 
 ## Contributing
 

{crackerjack-0.17.0 → crackerjack-0.17.2}/crackerjack/pyproject.toml

@@ -152,7 +152,7 @@ pythonPlatform = "Darwin"
 
 [project]
 name = "crackerjack"
-version = "0.16.1"
+version = "0.17.1"
 description = "Default template for PDM package"
 requires-python = ">=3.13"
 readme = "README.md"
@@ -184,14 +184,14 @@ dependencies = [
     "pydantic>=2.11.4",
     "pdm-bump>=0.9.12",
     "pdm>=2.24.1",
-    "uv>=0.7.2",
+    "uv>=0.7.3",
     "pytest-cov>=6.1.1",
     "pytest-mock>=3.14.0",
     "tomli-w>=1.2.0",
     "pytest-asyncio>=0.26.0",
     "rich>=14.0.0",
     "typer>=0.15.3",
-    "pytest-timeout>=2.3.1",
+    "pytest-timeout>=2.4.0",
 ]
 authors = [
     { name = "lesleslie", email = "les@wedgwoodwebworks.com" },

{crackerjack-0.17.0 → crackerjack-0.17.2}/pyproject.toml

@@ -171,7 +171,7 @@ pythonPlatform = "Darwin"
 
 [project]
 name = "crackerjack"
-version = "0.17.0"
+version = "0.17.2"
 description = "Default template for PDM package"
 requires-python = ">=3.13"
 readme = "README.md"
@@ -203,14 +203,14 @@ dependencies = [
     "pydantic>=2.11.4",
     "pdm-bump>=0.9.12",
     "pdm>=2.24.1",
-    "uv>=0.7.2",
+    "uv>=0.7.3",
     "pytest-cov>=6.1.1",
     "pytest-mock>=3.14.0",
     "tomli-w>=1.2.0",
     "pytest-asyncio>=0.26.0",
     "rich>=14.0.0",
     "typer>=0.15.3",
-    "pytest-timeout>=2.3.1",
+    "pytest-timeout>=2.4.0",
 ]
 authors = [
     { name = "lesleslie", email = "les@wedgwoodwebworks.com" },