release-creator 0.1.0__tar.gz

release_creator-0.1.0/.github/dependabot.yaml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    cooldown:
+      default-days: 7
+    labels:
+      - dependencies
+      - skip news
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: weekly
+    cooldown:
+      default-days: 7
+    labels:
+      - dependencies
+      - skip news

release_creator-0.1.0/.github/workflows/check.yaml

@@ -0,0 +1,104 @@
+name: check
+on:
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+    tags-ignore: ["**"]
+  pull_request:
+    types: [opened, synchronize, reopened, labeled, unlabeled]
+  schedule:
+    - cron: "0 8 * * *"
+permissions:
+  contents: read
+concurrency:
+  group: check-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  test:
+    name: test ${{ matrix.py }} on ${{ matrix.os.name }}
+    runs-on: ${{ matrix.os.image }}
+    strategy:
+      fail-fast: false
+      matrix:
+        py: ["3.15"]
+        os:
+          - {image: ubuntu-26.04, name: ubuntu}
+          - {image: windows-2025, name: windows}
+          - {image: macos-26, name: macos}
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          python-version: "3.15"
+          enable-cache: false
+      - name: Add uv tools to the Windows path
+        if: runner.os == 'Windows'
+        shell: bash
+        run: echo "$USERPROFILE/.local/bin" >> "$GITHUB_PATH"
+      - run: uv tool install --python-preference only-managed --python 3.15 tox --with tox-uv
+      - run: uv python install ${{ matrix.py }}
+      - run: tox run -vv --notest --skip-missing-interpreters false -e ${{ matrix.py }}
+      - run: tox run --skip-pkg-install -e ${{ matrix.py }}
+        env:
+          DIFF_AGAINST: ${{ github.event.pull_request.base.sha || 'HEAD' }}
+  check:
+    name: tox env ${{ matrix.tox_env }}
+    runs-on: ubuntu-26.04
+    strategy:
+      fail-fast: false
+      matrix:
+        tox_env: ["type", "pkg_meta", "docs", "dev"]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          python-version: "3.15"
+          enable-cache: false
+      - run: uv tool install --python-preference only-managed --python 3.15 tox --with tox-uv
+      - run: tox run -vv --notest --skip-missing-interpreters false -e ${{ matrix.tox_env }}
+      - run: tox run --skip-pkg-install -e ${{ matrix.tox_env }}
+  changelog:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-26.04
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          python-version: "3.15"
+          enable-cache: false
+      - name: Check release note requirement
+        env:
+          SKIP_NEWS: ${{ contains(github.event.pull_request.labels.*.name, 'skip news') }}
+          BOT_AUTHOR: ${{ github.event.pull_request.user.type == 'Bot' }}
+        run: |
+          set -euo pipefail
+          if git diff --name-only "origin/${GITHUB_BASE_REF}...HEAD" -- 'changelog.d/*.md' | grep -q .; then
+            uv run --no-default-groups --group release towncrier check --compare-with "origin/${GITHUB_BASE_REF}"
+          elif [[ "$SKIP_NEWS" != true && "$BOT_AUTHOR" != true ]]; then
+            echo '::error::add a changelog fragment or apply the skip news label'
+            exit 1
+          fi
+  gate:
+    name: Required checks pass
+    if: always()
+    needs: [test, check, changelog]
+    runs-on: ubuntu-26.04
+    steps:
+      - env:
+          NEEDS_JSON: ${{ toJSON(needs) }}
+        run: |
+          jq -e '
+            all(
+              to_entries[];
+              .value.result == "success" or
+              (.key == "changelog" and .value.result == "skipped")
+            )
+          ' <<< "$NEEDS_JSON"

release_creator-0.1.0/.github/workflows/prepare-release.yaml

@@ -0,0 +1,125 @@
+name: Prepare release
+on:
+  workflow_dispatch:
+    inputs:
+      bump:
+        description: Version bump type
+        required: true
+        type: choice
+        options:
+          - auto
+          - major
+          - minor
+          - patch
+          - calver
+        default: auto
+permissions: {}
+concurrency:
+  group: prepare-release
+  cancel-in-progress: false
+jobs:
+  assemble:
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-26.04
+    permissions:
+      contents: read
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          python-version: "3.15"
+          enable-cache: false
+      - name: Calculate next version
+        id: version
+        env:
+          BUMP: ${{ inputs.bump }}
+        run: |
+          set -euo pipefail
+          version=$(git tag --list | uv run --no-default-groups release-creator tags --next "$BUMP")
+          echo "Next version: $version"
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+      - name: Build release patch
+        env:
+          VERSION: ${{ steps.version.outputs.version }}
+        run: |
+          set -euo pipefail
+          git tag --list | uv run --no-default-groups release-creator tags "$VERSION" --require-newer
+          uv run --no-default-groups release-creator fragments --repository "$GITHUB_REPOSITORY" --git
+          uv run --no-default-groups --group release towncrier build --yes --version "$VERSION"
+          uvx prek exec mdformat -- mdformat --wrap 120 docs/changelog.md
+          uvx prek run --all-files
+          git diff HEAD --binary > "$RUNNER_TEMP/release.patch"
+          test -s "$RUNNER_TEMP/release.patch"
+      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: release-patch
+          path: ${{ runner.temp }}/release.patch
+          if-no-files-found: error
+  push:
+    needs: assemble
+    runs-on: ubuntu-26.04
+    environment: release-auth
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: release-patch
+          path: ${{ runner.temp }}/release-patch
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          python-version: "3.15"
+          enable-cache: false
+      - name: Validate release patch
+        env:
+          VERSION: ${{ needs.assemble.outputs.version }}
+        run: |
+          set -euo pipefail
+          git fetch origin main
+          if [[ $(git rev-parse origin/main) != "$GITHUB_SHA" ]]; then
+            echo "::error::main changed during release preparation; dispatch again"
+            exit 1
+          fi
+          git reset --hard origin/main
+          git apply --check "$RUNNER_TEMP/release-patch/release.patch"
+          git apply --index "$RUNNER_TEMP/release-patch/release.patch"
+          while IFS= read -r path; do
+            case "$path" in
+              docs/changelog.md|changelog.d/*.md) ;;
+              *) echo "::error::unexpected release path: $path"; exit 1 ;;
+            esac
+          done < <(git diff --cached --name-only)
+          grep -Fq "## $VERSION (" docs/changelog.md
+          git diff --cached --check
+          uvx prek run --all-files
+      - id: token
+        uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0
+        with:
+          client-id: ${{ vars.RELEASE_APP_CLIENT_ID }}
+          private-key: ${{ secrets.RELEASE_APP_PRIVATE_KEY }}
+          owner: ${{ github.repository_owner }}
+          repositories: ${{ github.event.repository.name }}
+          permission-contents: write
+      - name: Commit and tag the release
+        env:
+          VERSION: ${{ needs.assemble.outputs.version }}
+          GH_TOKEN: ${{ steps.token.outputs.token }}
+          APP_SLUG: ${{ steps.token.outputs.app-slug }}
+        run: |
+          set -euo pipefail
+          app_user_id=$(gh api "/users/${APP_SLUG}[bot]" --jq .id)
+          git config user.name "${APP_SLUG}[bot]"
+          git config user.email "${app_user_id}+${APP_SLUG}[bot]@users.noreply.github.com"
+          git commit -m "release $VERSION"
+          git tag "$VERSION"
+          gh auth setup-git --hostname github.com --force
+          git push --atomic origin HEAD:main "refs/tags/$VERSION"

release_creator-0.1.0/.github/workflows/release.yaml

@@ -0,0 +1,88 @@
+name: Release to PyPI
+on:
+  push:
+    tags: ["*"]
+permissions:
+  contents: read
+env:
+  dists-artifact-name: python-package-distributions
+jobs:
+  build:
+    runs-on: ubuntu-26.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          python-version: "3.15"
+          cache-dependency-glob: "pyproject.toml"
+          enable-cache: false
+      - name: Require a changelog section for the tag
+        env:
+          TAG: ${{ github.ref_name }}
+        run: |
+          uv run --no-default-groups release-creator tags "$TAG"
+          if ! grep -qF "## $TAG (" docs/changelog.md; then
+            echo "::error::docs/changelog.md has no section for $TAG"
+            exit 1
+          fi
+      - name: Check the tagged source
+        run: uvx prek run --all-files
+      - name: Build package
+        run: uv build --python 3.15 --python-preference only-managed --sdist --wheel . --out-dir dist
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: ${{ env.dists-artifact-name }}
+          path: dist/*
+  release:
+    needs:
+      - build
+    runs-on: ubuntu-26.04
+    environment:
+      name: release
+      url: https://pypi.org/project/release-creator/${{ github.ref_name }}
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: ${{ env.dists-artifact-name }}
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          attestations: true
+  github-release:
+    needs: release
+    runs-on: ubuntu-26.04
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          python-version: "3.15"
+          enable-cache: false
+      - name: Publish GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.ref_name }}
+        run: |
+          set -euo pipefail
+          previous=$(git tag --list | uv run --no-default-groups release-creator tags "$TAG" --previous)
+          args=()
+          if [[ -n "$previous" ]]; then
+            args+=(--previous "$previous")
+          fi
+          gh api -X POST "repos/${GITHUB_REPOSITORY}/releases/generate-notes" -f tag_name="$TAG" --jq .body > "$RUNNER_TEMP/generated-notes.md"
+          uv run --no-default-groups release-creator notes --changelog docs/changelog.md --tag "$TAG" --repository "$GITHUB_REPOSITORY" --artifact-url "https://pypi.org/project/release-creator/${TAG}/" --generated-notes "$RUNNER_TEMP/generated-notes.md" "${args[@]}" > "$RUNNER_TEMP/release-notes.md"
+          gh release create "$TAG" --verify-tag --title "v$TAG" --notes-file "$RUNNER_TEMP/release-notes.md"

release_creator-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+/.coverage
+/.pytest_cache
+/.ruff_cache
+/.tox
+/.venv
+/dist
+/htmlcov
+*.egg-info/
+__pycache__/
+/uv.lock

release_creator-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,56 @@
+default_language_version:
+  python: python3.15
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.38.2
+    hooks:
+      - id: check-github-workflows
+        args: ["--verbose"]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.3
+    hooks:
+      - id: codespell
+  - repo: https://github.com/tox-dev/pyproject-fmt
+    rev: v2.30.3
+    hooks:
+      - id: pyproject-fmt
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: "0.26"
+    hooks:
+      - id: validate-pyproject
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.17.0"
+    hooks:
+      - id: ruff-check
+        args: ["--fix", "--unsafe-fixes", "--exit-non-zero-on-fix"]
+      - id: ruff-format
+  - repo: https://github.com/asottile/blacken-docs
+    rev: 1.20.0
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==26.1]
+  - repo: https://github.com/google/yamlfmt
+    rev: "v0.21.0"
+    hooks:
+      - id: yamlfmt
+  - repo: local
+    hooks:
+      - id: mdformat
+        name: mdformat
+        entry: mdformat --wrap 120
+        language: python
+        types: [markdown]
+        additional_dependencies: ["mdformat-gfm>=1"]
+  - repo: https://github.com/zizmorcore/zizmor-pre-commit
+    rev: v1.30.1
+    hooks:
+      - id: zizmor
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes

release_creator-0.1.0/.readthedocs.yaml

@@ -0,0 +1,8 @@
+version: 2
+build:
+  os: ubuntu-26.04
+  tools: {}
+  commands:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - ~/.local/bin/uv tool install tox --with tox-uv -p 3.15 --managed-python
+    - ~/.local/bin/tox run -e docs -- "$READTHEDOCS_OUTPUT/html"

release_creator-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing to release-creator
+
+Run `tox -e dev` to create `.tox/dev`. Run `tox -e 3.15,type,pkg_meta,docs` and `prek run --all-files` before pushing a
+PR. CI tests Python 3.15 on Linux, macOS, and Windows.
+
+## Release notes
+
+Add a `changelog.d/+short-name.<type>.md` fragment for each user-visible change. No issue or PR number is needed when
+opening the PR. Use `feature` for additions, `change` for changed behavior, `bugfix` for fixes, or `doc` for
+documentation. Other types are `breaking`, `security`, `performance`, `deprecation`, `removal`, and `packaging`. Keep
+separate changes in separate fragments.
+
+Write a complete sentence and credit verified human authors:
+
+```markdown
+Render GitHub notes without wrapped bullets by [@gaborbernat](https://github.com/gaborbernat).
+```
+
+For multiple authors, join linked handles with `by x, y and z`. Do not credit reviewers or bots. Bot PRs need no
+fragment unless they supply a user-facing change; a bot-only fragment may omit `by`. Apply `skip news` to maintenance
+work. This label may be added after opening the PR, and it does not suppress checks for a supplied fragment.
+
+## Release process
+
+The `Prepare release` workflow reads the PR number from each fragment's squash commit, assembles a Towncrier changelog
+patch, runs `prek`, then uses the repository-scoped release App to commit and tag on `main`. The tag workflow runs
+`prek` again, builds the package, publishes to PyPI through trusted publishing, and creates a GitHub Release using the
+tagged `release-creator` source. Set up the App, `release-auth` environment, and PyPI trusted publisher before
+dispatching it.
+
+PR documentation builds show the branch's fragments in an `Unreleased` section on the changelog page. Towncrier adds
+them to `docs/changelog.md` only during release preparation.

release_creator-0.1.0/LICENSE

@@ -0,0 +1,18 @@
+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.

release_creator-0.1.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.5
+Name: release-creator
+Version: 0.1.0
+Summary: Release preparation tools for changelogs and GitHub
+Project-URL: Documentation, https://release-creator.readthedocs.io/
+Project-URL: Source, https://github.com/tox-dev/release-creator
+Project-URL: Tracker, https://github.com/tox-dev/release-creator/issues
+Author-email: Bernát Gábor <gaborjbernat@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: GitHub releases,changelog,release automation,release notes,towncrier
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Typing :: Typed
+Requires-Python: >=3.15
+Requires-Dist: mdformat-gfm<2,>=1
+Requires-Dist: mdformat<2,>=1
+Description-Content-Type: text/markdown
+
+# release-creator
+
+![release-creator logo](https://raw.githubusercontent.com/tox-dev/release-creator/main/docs/_static/logo-128.png)
+
+[![PyPI](https://img.shields.io/pypi/v/release-creator?style=flat-square)](https://pypi.org/project/release-creator/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/release-creator.svg)](https://pypi.org/project/release-creator/)
+[![check](https://github.com/tox-dev/release-creator/actions/workflows/check.yaml/badge.svg)](https://github.com/tox-dev/release-creator/actions/workflows/check.yaml)
+
+Release preparation tools for Python projects. The `notes` command renders a tagged changelog section for a GitHub
+Release. Other release tasks can use separate commands.
+
+The [documentation](https://release-creator.readthedocs.io/) has a tutorial, how-to guides, a generated command
+reference, and an explanation of the changelog format.
+
+## Render GitHub Release notes
+
+Run the current release from PyPI:
+
+```bash
+uvx --from 'release-creator' release-creator notes \
+  --changelog docs/changelog.md \
+  --tag 1.2.3 \
+  --repository tox-dev/example \
+  --previous 1.2.2 \
+  --artifact-url https://pypi.org/project/example/1.2.3/ > release-notes.md
+```
+
+For automation, replace `release-creator` after `--from` with a tested `release-creator==VERSION`. The command reads the
+tagged section, maps `Added` to `Features` and `Fixed` to `Bug fixes`, changes linked author handles to GitHub mentions,
+and leaves bullets unwrapped. It keeps stable category anchors, omits empty categories when they are absent from the
+source, and adds artifact and comparison links. Use `--artifact-label` for an ecosystem other than PyPI; omit
+`--artifact-url` when there is no external artifact.
+
+The command also accepts a `.rst` changelog with the same category names. For projects whose `:issue:` role points at
+PRs, pass `--issue-role pull`:
+
+```bash
+uvx --from 'release-creator' release-creator notes \
+  --changelog docs/changelog.rst \
+  --tag 1.2.3 \
+  --repository tox-dev/example \
+  --previous 1.2.2 \
+  --issue-role pull \
+  --artifact-url https://pypi.org/project/example/1.2.3/ > release-notes.md
+```
+
+The changelog is the source of truth. The command does not infer changes from commits or generate an author list. Add
+verified human credits to changelog entries before release; omit bot credits. The GitHub Release may add a
+`New Contributors` section by passing `--generated-notes` with the body from GitHub's generate-notes API. Only handles
+credited in the changelog are kept; the generated-notes banner and other generated sections are discarded.
+
+Named Towncrier fragments need no issue or PR number. Before Towncrier builds the changelog, run
+`release-creator fragments --repository owner/repo --git`. The command reads each fragment's introducing squash commit,
+adds its PR link, and fails if the subject does not end in `(#number)`. For a checkout without Git history, pass a
+tab-separated subject map with `--commit-map commits.tsv` instead.
+
+The `tags` command calculates a version from pending fragments, validates numeric tags, and selects the preceding tag
+for GitHub comparisons:
+
+```bash
+git tag --list | uvx --from 'release-creator' release-creator tags --next auto
+git tag --list | uvx --from 'release-creator' release-creator tags 1.2.3 --require-newer
+git tag --list | uvx --from 'release-creator' release-creator tags 1.2.3 --previous
+```
+
+## Development and releases
+
+See [contributing](https://github.com/tox-dev/release-creator/blob/main/CONTRIBUTING.md) for the fragment format and release process. The package uses the same `notes`
+command for its own GitHub Releases. Run `tox -e 3.15,type,pkg_meta,docs` and `prek run --all-files` before a PR.

release_creator-0.1.0/README.md

@@ -0,0 +1,69 @@
+# release-creator
+
+![release-creator logo](docs/_static/logo-128.png)
+
+[![PyPI](https://img.shields.io/pypi/v/release-creator?style=flat-square)](https://pypi.org/project/release-creator/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/release-creator.svg)](https://pypi.org/project/release-creator/)
+[![check](https://github.com/tox-dev/release-creator/actions/workflows/check.yaml/badge.svg)](https://github.com/tox-dev/release-creator/actions/workflows/check.yaml)
+
+Release preparation tools for Python projects. The `notes` command renders a tagged changelog section for a GitHub
+Release. Other release tasks can use separate commands.
+
+The [documentation](https://release-creator.readthedocs.io/) has a tutorial, how-to guides, a generated command
+reference, and an explanation of the changelog format.
+
+## Render GitHub Release notes
+
+Run the current release from PyPI:
+
+```bash
+uvx --from 'release-creator' release-creator notes \
+  --changelog docs/changelog.md \
+  --tag 1.2.3 \
+  --repository tox-dev/example \
+  --previous 1.2.2 \
+  --artifact-url https://pypi.org/project/example/1.2.3/ > release-notes.md
+```
+
+For automation, replace `release-creator` after `--from` with a tested `release-creator==VERSION`. The command reads the
+tagged section, maps `Added` to `Features` and `Fixed` to `Bug fixes`, changes linked author handles to GitHub mentions,
+and leaves bullets unwrapped. It keeps stable category anchors, omits empty categories when they are absent from the
+source, and adds artifact and comparison links. Use `--artifact-label` for an ecosystem other than PyPI; omit
+`--artifact-url` when there is no external artifact.
+
+The command also accepts a `.rst` changelog with the same category names. For projects whose `:issue:` role points at
+PRs, pass `--issue-role pull`:
+
+```bash
+uvx --from 'release-creator' release-creator notes \
+  --changelog docs/changelog.rst \
+  --tag 1.2.3 \
+  --repository tox-dev/example \
+  --previous 1.2.2 \
+  --issue-role pull \
+  --artifact-url https://pypi.org/project/example/1.2.3/ > release-notes.md
+```
+
+The changelog is the source of truth. The command does not infer changes from commits or generate an author list. Add
+verified human credits to changelog entries before release; omit bot credits. The GitHub Release may add a
+`New Contributors` section by passing `--generated-notes` with the body from GitHub's generate-notes API. Only handles
+credited in the changelog are kept; the generated-notes banner and other generated sections are discarded.
+
+Named Towncrier fragments need no issue or PR number. Before Towncrier builds the changelog, run
+`release-creator fragments --repository owner/repo --git`. The command reads each fragment's introducing squash commit,
+adds its PR link, and fails if the subject does not end in `(#number)`. For a checkout without Git history, pass a
+tab-separated subject map with `--commit-map commits.tsv` instead.
+
+The `tags` command calculates a version from pending fragments, validates numeric tags, and selects the preceding tag
+for GitHub comparisons:
+
+```bash
+git tag --list | uvx --from 'release-creator' release-creator tags --next auto
+git tag --list | uvx --from 'release-creator' release-creator tags 1.2.3 --require-newer
+git tag --list | uvx --from 'release-creator' release-creator tags 1.2.3 --previous
+```
+
+## Development and releases
+
+See [contributing](CONTRIBUTING.md) for the fragment format and release process. The package uses the same `notes`
+command for its own GitHub Releases. Run `tox -e 3.15,type,pkg_meta,docs` and `prek run --all-files` before a PR.

release_creator-0.1.0/docs/__init__.py

@@ -0,0 +1 @@
+"""Documentation configuration package."""

release_creator-0.1.0/docs/_static/custom.css

@@ -0,0 +1,11 @@
+article .highlight pre,
+article pre.literal-block {
+  white-space: pre-wrap;
+  overflow-wrap: anywhere;
+}
+
+figure pre.mermaid > svg {
+  width: auto;
+  height: auto;
+  max-width: 100% !important;
+}