pretty-release-notes 1.4.0__tar.gz → 1.4.2__tar.gz

pretty_release_notes-1.4.2/.cursorignore

@@ -0,0 +1 @@
+.env

pretty_release_notes-1.4.2/.github/workflows/lint.yml

@@ -0,0 +1,20 @@
+name: Lint
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.1

pretty_release_notes-1.4.2/.github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # trusted publishing, no API token needed
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name }}
+          fetch-depth: 0  # setuptools-scm reads the version from the tag
+
+      - uses: astral-sh/setup-uv@v5
+
+      - run: uv build
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

pretty_release_notes-1.4.2/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  release:
+    name: Create GitHub release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+
+      # RELEASE_TOKEN is a PAT, not GITHUB_TOKEN: releases created with the
+      # default token do not trigger the publish workflow.
+      - name: Run semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}
+        run: npx --yes semantic-release

pretty_release_notes-1.4.2/.github/workflows/tests.yml

@@ -0,0 +1,26 @@
+name: Tests
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e .[dev,web]
+
+      - name: Run tests
+        run: pytest --cov=pretty_release_notes --cov-report=term-missing

pretty_release_notes-1.4.2/.gitignore

@@ -0,0 +1,18 @@
+.env
+env/
+stored_lines.csv
+stored_lines.sqlite
+*.egg-info/
+__pycache__/
+*.pyc
+.vscode/
+.cursor/
+.claude/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+build/
+.omc/
+dist/

pretty_release_notes-1.4.2/.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+default_stages: [pre-commit]
+default_install_hook_types: [pre-commit]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: check-ast
+      - id: check-json
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      - id: ruff
+        name: "Run ruff import sorter"
+        args: ["--select=I", "--fix"]
+
+      - id: ruff
+        name: "Run ruff linter"
+
+      - id: ruff-format
+        name: "Run ruff formatter"
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.14.1
+    hooks:
+      - id: mypy
+        additional_dependencies: ['types-requests']
+
+  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
+    rev: v9.22.0
+    hooks:
+      - id: commitlint
+        stages: [commit-msg]
+        additional_dependencies: ['conventional-changelog-conventionalcommits']

pretty_release_notes-1.4.2/.releaserc

@@ -0,0 +1,8 @@
+{
+	"branches": ["main"],
+	"plugins": [
+		"@semantic-release/commit-analyzer",
+		"@semantic-release/release-notes-generator",
+		"@semantic-release/github"
+	]
+}

pretty_release_notes-1.4.2/CHANGELOG.md

@@ -0,0 +1,167 @@
+# 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.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [v1.4.1 - 2026-08-23]
+
+### Fixed
+
+- **PyPI page rendering**: README images and repository links used relative paths, which broke outside GitHub. They now use absolute URLs.
+- **Project links**: The `[project.urls]` metadata pointed at a repository that does not exist publicly.
+- **Packaging**: `dynamic = ["version"]` had no matching `[tool.setuptools.dynamic]` table, so the package could not be built.
+
+## [v1.3.0 - 2026-04-17]
+
+### Added
+
+- **Automated polling**: New `pretty-release-notes poll` command that checks GitHub for new releases and generates notes automatically. Supports `--seed` to initialize state and `--install-cron` to set up a cron job.
+- **`--yes` / `-y` flag**: Skip the confirmation prompt and update release notes on GitHub directly.
+
+### Changed
+
+- **Grouping enabled by default**: `group_by_type` now defaults to `true` across CLI, library, config loaders, and interactive setup.
+
+## [1.2.0 - 2026-03-10]
+
+### Added
+
+- **Multi-provider LLM support**: AI generation now runs through `any-llm`, allowing provider-qualified model values such as `openai:o3` and `anthropic:claude-sonnet-4-5`.
+- **Unified LLM configuration**: Added canonical `[llm]` config support, `llm_key` and `llm_model` request fields for the web API, and a new `ReleaseNotesBuilder.with_llm()` method for library usage.
+
+### Changed
+
+- **Default model handling**: Default model selection is now centralized across config loaders, interactive setup, examples, and runtime behavior, and provider-qualified `provider:model` values are now the preferred format.
+- **Backward compatibility**: Legacy OpenAI-style names such as `[openai]`, `openai_key`, `openai_model`, and `with_openai()` are still accepted and continue to map to the new LLM configuration flow.
+- **Default model value**: New configurations now default to `openai:o3` after the LLM integration refactor.
+
+## [1.1.0 - 2026-02-14]
+
+### Added
+
+- Breaking changes are now detected and grouped in their own section.
+
+### Fixed
+
+- The New Contributors section is now preserved when grouping by type.
+
+## [1.0.0]
+
+### Added
+- **TOML Configuration**: New TOML-based configuration format stored in `~/.pretty-release-notes/config.toml`. Provides structured, human-readable configuration with sections for GitHub, OpenAI, database, and filters.
+- **Interactive Setup Command**: New `pretty-release-notes setup` command with interactive prompts for creating and updating configuration files. Shows existing values as defaults and validates all inputs.
+- **Configuration Migration**: Setup command can migrate from legacy `.env` files using the `--migrate-env` flag.
+
+### Changed
+- **Database Storage Location**: Database files are now stored in `~/.pretty-release-notes/` by default instead of the project directory. This provides better separation between user data and application code, follows platform conventions, and avoids permission issues.
+- **Configuration Format**: TOML is now the default configuration format. The `.env` format is still supported via `EnvConfigLoader` but is considered legacy.
+
+### Fixed
+- **Empty String Defaults**: Setup command now correctly handles empty strings in existing config files, falling back to proper defaults instead of keeping empty values.
+
+### Migration Guide
+
+#### Migrating to TOML Configuration
+
+If you're currently using a `.env` file for configuration, you have two options:
+
+**Option 1: Automated Migration (Recommended)**
+```bash
+# Run the interactive setup with migration flag
+pretty-release-notes setup --migrate-env
+```
+
+This will:
+- Read your existing `.env` file
+- Show all values as defaults in interactive prompts
+- Create the new TOML config at `~/.pretty-release-notes/config.toml`
+- Optionally delete the old `.env` file
+
+**Option 2: Manual Migration**
+1. Copy the example config:
+   ```bash
+   mkdir -p ~/.pretty-release-notes
+   cp config.toml.example ~/.pretty-release-notes/config.toml
+   ```
+
+2. Edit the file with your credentials:
+   ```bash
+   nano ~/.pretty-release-notes/config.toml
+   ```
+
+3. Map your `.env` variables to TOML sections:
+   ```toml
+   # .env: GH_TOKEN → TOML:
+   [github]
+   token = "your_token_here"
+
+   # .env: OPENAI_API_KEY → TOML:
+   [openai]
+   api_key = "your_key_here"
+   ```
+
+**No migration needed if:**
+- Your application uses the Library API with programmatic configuration
+- You're passing configuration via `DictConfigLoader`
+- You want to continue using `.env` (still supported via `EnvConfigLoader`)
+
+#### Moving Existing Database Files
+
+If you have existing database files in your project directory and want to preserve your cached release note summaries, follow these steps:
+
+**For SQLite databases (default):**
+```bash
+# Create the new directory if it doesn't exist
+mkdir -p ~/.pretty-release-notes
+
+# Move your existing database file
+mv /path/to/your/project/stored_lines.sqlite ~/.pretty-release-notes/
+
+# Or if your database has a custom name
+mv /path/to/your/project/your_db_name.sqlite ~/.pretty-release-notes/
+```
+
+**For CSV databases:**
+```bash
+# Create the new directory if it doesn't exist
+mkdir -p ~/.pretty-release-notes
+
+# Move your existing CSV file
+mv /path/to/your/project/stored_lines.csv ~/.pretty-release-notes/
+```
+
+**Alternatively, continue using your old location:**
+
+If you prefer to keep your database in its current location, you can specify an absolute path in your configuration:
+
+```toml
+# In config.toml
+[database]
+name = "/absolute/path/to/your/database/stored_lines"
+```
+
+Or in `.env` (legacy):
+```bash
+DB_NAME=/absolute/path/to/your/database/stored_lines
+```
+
+The tool will automatically detect absolute paths and use them as-is.
+
+#### Why This Change?
+
+1. **Cleaner separation**: User data is separated from application code
+2. **Platform conventions**: Follows standard practice for user data storage
+3. **No permission issues**: User home directory is always writable
+4. **Multi-user support**: Each user can maintain their own cache
+5. **Version control safe**: No risk of accidentally committing database files
+
+#### Configuration Reference
+
+The `DB_NAME` configuration variable now behaves as follows:
+
+- **Relative path** (default): `DB_NAME=stored_lines` → `~/.pretty-release-notes/stored_lines.sqlite`
+- **Absolute path**: `DB_NAME=/var/cache/prn/db` → `/var/cache/prn/db.sqlite`
+
+No changes are required to existing configuration files. The default behavior has simply changed to use the user directory.