instructor-ai/instructorNew scan
87/ 100 · B

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

structured outputs for llms

Python13,160 starsMITupdated 8d ago
DocumentationREADME, setup, examples, license
77
EngineeringTests, CI, linting, lockfiles
89
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.

  2. 2
    CI/CD
    EngineeringInfo

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

  3. 3
    CI/CD
    EngineeringInfo

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

Detailed breakdown

Documentation

77
  • README80
    • README is present.
    • README is well structured with multiple sections.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions45
    • README documents how to install the project.
    • No run or usage instructions found (−45 pts).Add a section showing how to start or use the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide98
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

89
  • Tests100
    • Test files detected (examples/batch_api/run_batch_test.py).
    • Pytest configured via [tool.pytest.ini_options] in pyproject.toml with test files present.
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/test_docs.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI does not appear to run a linter (−15 pts).Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI tests across multiple environments or versions.
  • Linting and formatting60
    • Linter or formatter configured (.ruff.toml).
  • Reproducibility92
    • Lockfile present (requirements.txt). Installs are reproducible.
    • Environment pinned via examples/citation_with_extraction/Dockerfile.
    • Dependabot configured for pip.
    • Dependabot only covers one ecosystem (+12 pts; covering 2+ earns +20 pts).Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.
  • Issue and PR templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (pyproject.toml).
    • pyproject.toml has a [project] table with package metadata.
    • pyproject.toml includes a description.
    • pyproject.toml specifies requires-python, preventing installs on incompatible versions.
    • pyproject.toml has a [build-system] table. The package can be built and published.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Python.
    • pyproject.toml [project] metadata is complete (description, authors, urls).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 13,160 stars.
  • Housekeeping100
    • .gitignore present.
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
    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.
  • CLAUDE.md
  • CONTRIBUTING.md
  • 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.
    Warning: 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.
    Warning: 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