instructor-ai/instructor
Grade a repo

90

/ 100

GradeA

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Top 12% of 5,156 graded repos

structured outputs for llms

Documentation77
Engineering95
Health100
Python13,241MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

7 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
    CI/CD14pt

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  4. 4
    README12pt

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

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

77

Install and run instructions9pt45

README documents how to install the project.

README12pt80

README is present.

License6pt100

Licensed under MIT.

Contributing guide5pt100

Contributing guide is detailed and thorough.

Engineering

95

CI/CD14pt85

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

Reproducibility6pt92

Lockfile present (requirements.txt). Installs are reproducible.

Tests18pt100

Test files detected (examples/batch_api/run_batch_test.py).

Linting and formatting5pt100

Linter or formatter configured (.ruff.toml).

Issue and PR templates6pt100

Issue or PR templates present.

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

  • 4 / 23
    Commits (30d / 90d)
  • 1,092
    Forks
  • 109
    Releaseslatest 3y ago

Community

  • 62% - Fair
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 13,241
    Watchers

Responsiveness

  • 2d 15h
    Median issue response
  • 2h
    Median PR merge time
  • 64
    Open issues
Repository files33 root entries
  • .cursor
  • .github
    Good: CI is configured (.github/workflows/test_docs.yml).
    Good: Dependabot configured for pip.
    Good: Issue or PR templates present.
  • .grit
  • docs
  • examples
    Good: Test files detected (examples/batch_api/run_batch_test.py).
    Good: Environment pinned via examples/citation_with_extraction/Dockerfile.
  • instructor
  • scripts
  • tests
  • .coveragerc
  • .cursorignore
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .ruff.toml
    Good: Linter or formatter configured (.ruff.toml).
  • AGENT.md
  • build_mkdocs.sh
  • CHANGELOG.md
  • CLAUDE.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • cross_link_mapping.yaml
  • ellipsis.yaml
  • github_issue.md
  • LICENSE
    Good: Licensed under MIT.
  • mkdocs.yml
  • NEW_PROVIDER_AGENT_INSTRUCTIONS.md
  • 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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • requirements-doc.txt
  • requirements-examples.txt
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
  • sitemap.yaml
  • ty-tests.toml
  • ty.toml
  • uv.lock
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/instructor-ai/instructor)](https://www.repo-grade.com/report/instructor-ai/instructor)

More graded Python repos