allenhutchison/podcast-rag
Grade a repo

0

/ 100

GradeB

Well engineered for its size. A portfolio piece worth showing off.

Top 22% of 5,156 graded repos

Using a set of MP3 podcasts, create a RAG System to work with the model of your choice.

Documentation78
Engineering83
Health100
Python19Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

8 to address
  1. 1
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  2. 2
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  4. 4
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

78

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

README12pt80

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Apache-2.0.

Engineering

83

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

CI/CD14pt85

CI is configured (.github/workflows/test.yml).

Tests18pt100

Test files detected (scripts/test_email.py).

Linting and formatting5pt100

Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).

Reproducibility6pt100

Lockfile present (uv.lock). Installs are reproducible.

Project health

100

Dependency manifest6pt100

Dependency manifest found (pyproject.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 4
    Forks
  • 28
    Releaseslatest 8mo ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 19
    Watchers

Responsiveness

  • <1h
    Median issue response
  • <1h
    Median PR merge time
  • 10
    Open issues
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Dependabot covers 2 ecosystems (uv, github-actions). Dependencies stay current.
  • alembic
  • docs
  • scripts
    Good: Test files detected (scripts/test_email.py).
  • src
  • tests
  • .dockerignore
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • alembic.ini
  • CLAUDE.md
  • docker-compose.dev.yml
  • docker-compose.yml
  • docker-entrypoint.sh
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile.web
  • GEMINI.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/allenhutchison/podcast-rag)](https://www.repo-grade.com/report/allenhutchison/podcast-rag)

More graded Python repos