pallets/click
Grade a repo

88

/ 100

GradeA

Excellent work. The main thing left to polish is setup instructions.

Top 12% of 5,156 graded repos

Python composable command line interface toolkit

Documentation75
Engineering96
Health98
Python17,571BSD-3-Clause23d ago

Top fixes

Highest-impact changes first, ranked by point weight

11 to address
  1. 1
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

  2. 2
    Install and run instructions9pt

    Add a section showing how to install dependencies.

  3. 3
    Install and run instructions9pt

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

  4. 4
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

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

75

Install and run instructions9pt45

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

Contributing guide5pt66

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt90

README is present.

License6pt100

Licensed under BSD-3-Clause.

Engineering

96

Reproducibility6pt70

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

Tests18pt100

Test files detected (tests).

CI/CD14pt100

CI is configured (.github/workflows/tests.yaml).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

98

Dependency manifest6pt93

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

  • 18 / 126
    Commits (30d / 90d)
  • 1,846
    Forks
  • 29
    Releaseslatest 4y ago

Community

  • 100% - Good
    Community health
  • 3 bus factor
    authors own >50% of commits
  • 17,571
    Watchers

Responsiveness

  • 3h
    Median issue response
  • 4h
    Median PR merge time
  • 93
    Open issues
Repository files15 root entries
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/tests.yaml).
    Good: Issue or PR templates present.
  • docs
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Good: Contributing guide includes code examples.
  • examples
  • src
  • tests
    Good: Test files detected (tests).
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .readthedocs.yaml
  • CHANGES.md
  • LICENSE.txt
    Good: Licensed under BSD-3-Clause.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    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/pallets/click)](https://www.repo-grade.com/report/pallets/click)

More graded Python repos