oss-maintainer-pulse 0.1.5

Offline-first GitHub issue and pull request health reports for open-source maintainers.

Maintainer Pulse

Maintainer Pulse turns GitHub issue and pull request data into a short, actionable maintenance report. It is built for open-source maintainers who need to answer:

• What should I review before the next release?
• Which pull requests are stuck?
• Which issues have not received a maintainer response?
• What can a new contributor safely pick up?

The tool is offline-first. You can run it against exported GitHub JSON without a token, or fetch live issue and pull request data from the GitHub API.

Features

• Release blocker, stuck pull request, stale item, first-response, and quick-win queues.
• Milestone-aware release blocker grouping for release planning.
• Markdown, HTML, JSON, and CSV output.
• Reusable GitHub Action for scheduled reports.
• No runtime dependencies.
• Deterministic scoring that can be reviewed and changed by maintainers.
• GitHub Actions CI and fixture-based tests.

Install

From PyPI:

python -m pip install oss-maintainer-pulse

From GitHub:

python -m pip install git+https://github.com/alibert99/oss-maintainer-pulse.git

From a local checkout:

python -m pip install .

For local development:

python -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
pytest

Usage

Analyze an exported GitHub issues payload:

maintainer-pulse example/project \
  --input examples/github_items.json \
  --output maintainer-pulse-report.md

Fetch live data from GitHub:

export GITHUB_TOKEN=github_pat_your_token_here
maintainer-pulse octo-org/octo-repo --format html --output report.html

Generate machine-readable output:

maintainer-pulse octo-org/octo-repo --format json

Generate spreadsheet-friendly output:

maintainer-pulse octo-org/octo-repo --format csv --output maintainer-pulse-report.csv

See examples/sample-report.md for a generated report. See examples/sample-report.csv for spreadsheet-friendly output.

GitHub Action

Run Maintainer Pulse weekly and upload a report artifact:

name: Maintainer Pulse

on:
  workflow_dispatch:
  schedule:
    - cron: "17 9 * * 1"

permissions:
  contents: read
  issues: read
  pull-requests: read

jobs:
  report:
    runs-on: ubuntu-latest
    steps:
      - uses: alibert99/oss-maintainer-pulse@v0.1.5
        id: pulse
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          output: maintainer-pulse-report.md
      - uses: actions/upload-artifact@v7
        with:
          name: maintainer-pulse-report
          path: ${{ steps.pulse.outputs.report-path }}

See docs/github-action.md for all inputs.

Distribution

• GitHub Action listing draft: docs/marketplace-listing.md
• PyPI publishing guide: docs/pypi-publishing.md

Output Queues

Maintainer Pulse groups work into five queues:

• release_blockers: open issues and pull requests with labels such as security, regression, critical, release, p0, or p1. Markdown reports group release blockers by GitHub milestone when milestone data is present.
• stuck_pull_requests: pull requests idle for at least seven days or labeled for review.
• response_debt: open items with zero comments and at least three idle days.
• stale_items: open items idle beyond the configured stale threshold.
• quick_wins: small contributor-friendly issues labeled good first issue, help wanted, documentation, or starter.

CSV output includes one row per queued item with the queue name, item number, type, state, labels, author, comment count, idle days, age days, timestamps, and URL.

Project Status

This project is alpha. The CLI and report fields may change as maintainers test it against real repositories.