pr-generator-agent 1.0.0__tar.gz

pr_generator_agent-1.0.0/.flake8

@@ -0,0 +1,9 @@
+[flake8]
+max-line-length = 100
+# Ignore whitespace before ':' (conflicts with Black)
+extend-ignore = E203
+
+# Ignore specific errors in specific files
+per-file-ignores = 
+    __init__.py: F401
+    tests/*: F401,F841 

pr_generator_agent-1.0.0/.github/commit-convention.md

@@ -0,0 +1,5 @@
+# Commit Convention
+
+This project follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+## Format 

pr_generator_agent-1.0.0/.github/dependabot.yml

@@ -0,0 +1,24 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip"  # For Python packages
+    directory: "/"  # Location of package manifests
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    labels:
+      - "dependencies"
+      - "python"
+
+  - package-ecosystem: "github-actions"  # For GitHub Actions
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    labels:
+      - "dependencies"
+      - "github-actions"

pr_generator_agent-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,62 @@
+name: Release Management
+
+on:
+  push:
+    branches: [ "main" ]
+  workflow_dispatch:
+    inputs:
+      publish_to_pypi:
+        description: "Publish current release to PyPI"
+        required: true
+        type: boolean
+        default: false
+
+permissions:
+  contents: write
+  pull-requests: write
+  id-token: write
+  security-events: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: googleapis/release-please-action@v4
+        with:
+          release-type: python
+          package-name: pr-generator-agent
+          path: .
+          config-file: .release-please-config.json
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' && github.event.inputs.publish_to_pypi == 'true'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+      - name: Build package
+        run: python -m build
+      - name: Check PyPI token
+        run: |
+          if [ -z "${{ secrets.PYPI_API_TOKEN }}" ]; then
+            echo "Error: PYPI_API_TOKEN secret is not set"
+            exit 1
+          fi
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }} 

pr_generator_agent-1.0.0/.github/workflows/test.yml

@@ -0,0 +1,87 @@
+name: Python Tests & Lint
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches-ignore:
+      - main  # Exclude main as it's handled by release workflow
+      - 'dependabot/**'  # Exclude dependabot branches
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+      - '.gitignore'
+      - 'LICENSE'
+
+# Minimal permissions required for running tests and linting
+permissions:
+  contents: read  # Needed to checkout code
+  checks: write   # Needed for test reporting
+
+jobs:
+  lint:
+    name: Code Quality Checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'  # Use latest stable Python for linting
+          
+      - name: Cache Python dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-lint-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-lint-
+            
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+          
+      - name: Run linters
+        run: |
+          black --check aipr/ tests/
+          isort --check aipr/ tests/
+          flake8 aipr/ tests/
+
+  test:
+    name: Python Tests
+    needs: lint  # Only run tests if linting passes
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        # We support the latest two stable Python versions plus beta
+        python-version: ['3.10', '3.11']  # Removed 3.13 as it's still in beta
+        
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          check-latest: true
+          
+      - name: Cache Python dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-test-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-test-${{ matrix.python-version }}-
+            
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+          
+      - name: Run tests
+        run: |
+          pytest --cov=aipr --cov-report=term-missing 

pr_generator_agent-1.0.0/.gitignore

@@ -0,0 +1,59 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual Environment
+.env
+.venv
+env/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+.DS_Store
+
+# Testing
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+htmlcov/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Local development
+*.log
+local_settings.py

pr_generator_agent-1.0.0/.python-version

@@ -0,0 +1 @@
+3.13

pr_generator_agent-1.0.0/.release-please-config.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+  "release-type": "python",
+  "package-name": "pr-generator-agent",
+  "changelog-sections": [
+    {"type": "feat", "section": "Features", "hidden": false},
+    {"type": "fix", "section": "Bug Fixes", "hidden": false},
+    {"type": "perf", "section": "Performance Improvements", "hidden": false},
+    {"type": "revert", "section": "Reverts", "hidden": false},
+    {"type": "docs", "section": "Documentation", "hidden": false},
+    {"type": "style", "section": "Styles", "hidden": true},
+    {"type": "chore", "section": "Miscellaneous Chores", "hidden": true},
+    {"type": "refactor", "section": "Code Refactoring", "hidden": false},
+    {"type": "test", "section": "Tests", "hidden": true},
+    {"type": "build", "section": "Build System", "hidden": true},
+    {"type": "ci", "section": "Continuous Integration", "hidden": true}
+  ]
+} 

pr_generator_agent-1.0.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.0.0"
+} 

pr_generator_agent-1.0.0/CHANGELOG.md

@@ -0,0 +1,67 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0](https://github.com/danielscholl/pr-generator-agent/compare/v0.1.2...v1.0.0) (2025-02-17)
+
+
+### ⚠ BREAKING CHANGES
+
+* Promoting to first major release 1.0.0. This marks the first stable release of the AIPR tool.
+
+### Features
+
+* promote to version 1.0.0 ([ae85038](https://github.com/danielscholl/pr-generator-agent/commit/ae850384909425efe311c770e3a1cc087dbdd059))
+
+## [0.1.2](https://github.com/danielscholl/pr-generator-agent/compare/v0.1.1...v0.1.2) (2025-02-17)
+
+
+### Bug Fixes
+
+* add explicit path to release-please config ([6343f66](https://github.com/danielscholl/pr-generator-agent/commit/6343f66db39c196e97d114e2a7e82eb7b7c44579))
+* correct release-please versioning configuration ([58b6718](https://github.com/danielscholl/pr-generator-agent/commit/58b6718c299c318b402c071659fb646675e12537))
+* file ([645c225](https://github.com/danielscholl/pr-generator-agent/commit/645c2255e813254852e541b44d8876db37578c4e))
+* file ([e761857](https://github.com/danielscholl/pr-generator-agent/commit/e76185745e08934aab79b4998499dcb748d0c728))
+* improve release-please version management configuration ([d5a62c9](https://github.com/danielscholl/pr-generator-agent/commit/d5a62c9a98d1cc1f6999c37162955b44edaa735c))
+* update release-please config to use toml type and path ([939a94f](https://github.com/danielscholl/pr-generator-agent/commit/939a94ff3a819e919fa4421d805f73f4945857e9))
+* update release-please configuration for better version management ([4de1559](https://github.com/danielscholl/pr-generator-agent/commit/4de1559a73153a739423a74ab353828429553524))
+* update release-please configuration for better version management ([71b1277](https://github.com/danielscholl/pr-generator-agent/commit/71b1277a71d238fc804b7616a70aabab05a87816))
+* update release-please extra-files type to simple ([1e71c6e](https://github.com/danielscholl/pr-generator-agent/commit/1e71c6eb1cdd016c468b737bee09efc93440cfb4))
+* update release-please setup for single package ([2e45307](https://github.com/danielscholl/pr-generator-agent/commit/2e4530796519f008b1a9150b856e0abd2342f728))
+
+## [0.1.1](https://github.com/danielscholl/pr-generator-agent/compare/v0.1.0...v0.1.1) (2025-02-17)
+
+
+### Bug Fixes
+
+* project file ([040d592](https://github.com/danielscholl/pr-generator-agent/commit/040d5920db5d082cb5f7de23ff5939cb70608313))
+* update package name to pr-generator-agent and align documentation ([a8605ba](https://github.com/danielscholl/pr-generator-agent/commit/a8605ba3bd1b2cb7ac21c315f5c19a119f990f8c))
+
+## 0.1.0 (2025-02-16)
+
+
+### Features
+
+* initial release of AIPR ([81b40cb](https://github.com/danielscholl/pr-generator-agent/commit/81b40cbd77e0bc767e93f657c71d701f494d261b))
+
+## [1.0.0] - 2025-02-17
+
+### Added
+- Initial release of AIPR (AI Pull Request Generator)
+- Core functionality to generate AI-powered pull request descriptions
+- Support for both OpenAI and Anthropic Claude models
+- Git integration for analyzing changes and generating contextual PR descriptions
+- Command-line interface with customizable options
+- Automatic token counting and context management
+- Support for Python 3.10 and above
+- Comprehensive test suite with pytest
+- GitHub Actions workflows for testing and releases
+- Development environment setup with black, isort, and flake8
+
+### Features
+- Customizable prompt system with XML-based prompt definitions ([Custom Prompts PRD](docs/custom_prompts_prd.md))
+
+[1.0.0]: https://github.com/danielscholl/pr-generator-agent/releases/tag/v1.0.0

pr_generator_agent-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,159 @@
+# Contributing to AIPR
+
+We welcome pull requests from everyone! Whether it's a bug fix, new feature, or documentation improvement, we appreciate your help. This guide will help you get started.
+
+## Before You Start
+
+- If you're planning a large or complex change, please open an issue first to discuss the approach.
+- Have questions? Open a Discussion or create an Issue with the "question" label.
+- All contributions must follow our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Development Guide
+
+1. **Prerequisites**
+   - Python 3.10 or higher
+   - Git
+   - GitHub account
+   - GitHub CLI (`gh`) - https://cli.github.com
+
+2. **Package and Command Names**
+   - PyPI Package Name: `pr-generator-agent` (for installation)
+   - Module Name: `aipr` (for imports)
+   - Command Name: `aipr` (CLI tool)
+   
+   Example usage:
+   ```bash
+   # Installing the package
+   pip install pr-generator-agent
+   
+   # Using the CLI tool
+   aipr
+   
+   # Importing in Python
+   from aipr import ...
+   ```
+
+3. **Development Commands**
+```bash
+# Key make targets
+make install  # Sets up the virtualenv and installs dependencies
+make check    # Runs linting, formatting, tests
+make test     # Just run the test suite
+make pr       # Creates a pull request via gh/glab
+make clean    # Removes build artifacts & venv
+```
+
+4. **Code Style**
+- We use Black for code formatting and Flake8 for linting
+- All code must pass `make check` before being merged
+- GitHub Actions will automatically verify these checks on your PR
+
+5. **Commit Conventions**
+We use [Conventional Commits](https://www.conventionalcommits.org/) to automate versioning and changelog generation. Your commit messages should follow this format:
+```
+type(optional-scope): description
+
+[optional body]
+[optional footer(s)]
+```
+
+Types that affect versioning:
+- `feat:` - New feature (bumps minor version)
+- `fix:` - Bug fix (bumps patch version)
+- `feat!:` or `fix!:` - Breaking change (bumps major version)
+
+Other types (don't affect version):
+- `docs:` - Documentation changes
+- `style:` - Code style changes
+- `refactor:` - Code changes that neither fix a bug nor add a feature
+- `test:` - Adding/updating tests
+- `chore:` - Maintenance tasks
+
+Examples:
+```bash
+git commit -m "feat: add support for OpenAI models"
+git commit -m "fix: handle empty commit messages"
+git commit -m "feat!: switch to new API version"
+git commit -m "docs: update installation instructions"
+```
+
+6. **Initial Setup**
+```bash
+# Verify GitHub CLI is installed and authenticated
+gh auth status
+
+# Fork the repository and clone it
+gh repo fork danielscholl/pr-generator-agent --clone=true
+cd pr-generator-agent
+
+# The gh fork command automatically sets up the upstream remote
+# You can verify with: git remote -v
+
+# Create virtual environment and install dependencies
+make install
+
+# Activate the virtual environment
+source .venv/bin/activate 
+```
+
+7. **Making Changes**
+```bash
+# Ensure your fork is up to date
+git fetch upstream
+git checkout main
+git merge upstream/main
+
+# Create a new branch
+git checkout -b feature-name
+
+# Make your changes...
+
+# Verify your changes
+make check
+
+# Commit and push your changes
+git add .
+git commit -m "feat: description of your changes"  # Use conventional commits!
+git push -u origin feature-name
+
+# Create a pull request
+make pr                         # Uses commit messages for title and description
+make pr title="Add new feature" # Uses a specific title
+```
+
+## Release Process
+
+Releases are automated using Release Please. Here's how it works:
+
+1. **Versioning**
+   - Commits to `main` automatically trigger version updates based on conventional commits
+   - `fix:` commits bump the patch version (0.1.0 → 0.1.1)
+   - `feat:` commits bump the minor version (0.1.0 → 0.2.0)
+   - `feat!:` or any commit with `!` bump the major version (0.1.0 → 1.0.0)
+
+2. **Release Flow**
+   - Push commits to main using conventional commit messages
+   - Release Please automatically creates/updates a release PR
+   - When the release PR is merged:
+     - Version is bumped in `pyproject.toml` and `__init__.py`
+     - Changelog is updated
+     - GitHub release is created
+     - Git tag is created
+
+3. **Publishing**
+   - Publishing to PyPI is a manual step
+   - Go to Actions → Release Management
+   - Click "Run workflow"
+   - Select "Publish current release to PyPI"
+   - Click "Run workflow"
+
+## Pull Request Process
+
+1. After opening a PR, a maintainer will review your changes
+2. We aim to respond within 3 business days
+3. We may request changes or additional tests
+4. Once approved and all checks pass, we'll merge your contribution
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

pr_generator_agent-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Daniel Scholl
+
+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. 

pr_generator_agent-1.0.0/Makefile

@@ -0,0 +1,85 @@
+.PHONY: install check clean build pr clean-pyc
+
+# Virtual environment settings
+VENV := .venv
+
+clean-pyc:
+	@echo "Cleaning Python cache..."
+	find . -name '*.pyc' -delete
+	find . -name '*.pyo' -delete
+	find . -name '__pycache__' -type d -exec rm -rf {} +
+
+install: clean-pyc
+	@echo "Setting up development environment..."
+	python3 -m venv $(VENV)
+	# Install in the virtual environment (temporary activation)
+	. $(VENV)/bin/activate && python -m pip install -e ".[dev]"
+	@echo "\nVerifying installation:"
+	@echo "Binary location: $(VENV)/bin/aipr"
+	@echo "Python package location: $$($(VENV)/bin/python -c "import aipr; print(aipr.__file__)")"
+	@echo "\nNext step:"
+	@echo "To begin development, run: source .venv/bin/activate"
+	@echo "This will activate the virtual environment in your shell"
+
+format:
+	. $(VENV)/bin/activate && python -m black aipr/ tests/
+	. $(VENV)/bin/activate && python -m isort aipr/ tests/
+
+lint:
+	. $(VENV)/bin/activate && python -m flake8 aipr/ tests/
+
+test:
+	. $(VENV)/bin/activate && python -m pytest
+
+check: format lint test
+	@echo "\nAll checks passed!"
+	@echo "Next step: Ready to commit your changes"
+
+clean:
+	@echo "Cleaning up build artifacts and virtual environment..."
+	rm -rf dist/ build/ *.egg-info .coverage htmlcov/ .pytest_cache/ $(VENV)
+	find . -name '__pycache__' -type d -exec rm -rf {} +
+	@echo "\nNext step:"
+	@echo "Run 'deactivate' to ensure python is not running in the virtual environment"
+
+build: clean
+	. $(VENV)/bin/activate && python -m build
+
+# GitHub PR target
+# Usage: make pr title="Your PR title"
+pr:
+	@if [ -z "$(title)" ]; then \
+		echo "Error: title parameter is required. Usage: make pr title=\"Your PR title\""; \
+		exit 1; \
+	fi
+	@if [ -n "$$(git status --porcelain)" ]; then \
+		echo "Error: You have uncommitted changes. Please commit or stash them first."; \
+		exit 1; \
+	fi
+	@BRANCH=$$(git branch --show-current); \
+	if ! git show-ref --verify --quiet refs/remotes/origin/$$BRANCH; then \
+		if git ls-remote --exit-code --heads origin $$BRANCH >/dev/null 2>&1; then \
+			git branch --set-upstream-to=origin/$$BRANCH $$BRANCH 2>/dev/null || true; \
+		else \
+			echo "Error: Branch '$$BRANCH' does not exist on remote 'origin'."; \
+			echo "Please push the branch with: git push --set-upstream origin $$BRANCH"; \
+			exit 1; \
+		fi; \
+	fi
+	@if [ -n "$$(git log @{u}.. 2>/dev/null)" ]; then \
+		echo "Error: You have unpushed commits. Please push them first: git push"; \
+		exit 1; \
+	fi
+	@BRANCH=$$(git branch --show-current); \
+	PR_COUNT=$$(gh pr list --head $$BRANCH --state open --json number --jq 'length'); \
+	if [ "$$PR_COUNT" -gt 0 ]; then \
+		echo "Updating existing pull request for branch $$BRANCH..."; \
+		. $(VENV)/bin/activate && aipr -s --vulns -m azure/o1-mini -p meta | gh pr edit $$BRANCH --body-file -; \
+		echo "\nPull request updated!"; \
+		echo "Next step: Address any new feedback"; \
+	else \
+		echo "Creating new pull request for branch $$BRANCH..."; \
+		. $(VENV)/bin/activate && aipr -s --vulns -m azure/o1-mini -p meta | gh pr create --body-file - -t "$(title)"; \
+		echo "\nPull request created!"; \
+		echo "Next step: Wait for review and address any feedback"; \
+	fi