sphinx-gallery/sphinx-gallery
Grade a repo

75

/ 100

GradeC

Good shape overall. A few tweaks would push it into the top tier.

Top 39% of 5,156 graded repos

Sphinx extension for automatic generation of an example gallery

Documentation59
Engineering76
Health98
Python454BSD-3-Clause1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

15 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  3. 3
    CI/CD14pt

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

  4. 4
    README12pt

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

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

59

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

README12pt40

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under BSD-3-Clause.

Engineering

76

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.

Reproducibility6pt82

Lockfile present (doc/binder/requirements.txt). Installs are reproducible.

Tests18pt85

Test files detected (sphinx_gallery/tests).

CI/CD14pt85

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

Linting and formatting5pt100

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

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

  • 8 / 28
    Commits (30d / 90d)
  • 213
    Forks
  • 47
    Releaseslatest 9y ago

Community

  • 37% - Weak
    Community health
  • 3 bus factor
    authors own >50% of commits
  • 454
    Watchers

Responsiveness

  • 3h
    Median issue response
  • 5d 16h
    Median PR merge time
  • 129
    Open issues
Repository files22 root entries
  • .circleci
  • .github
    Good: CI is configured (.github/workflows/circle_artifacts.yml).
    Good: Dependabot configured for github-actions.
  • doc
    Good: Lockfile present (doc/binder/requirements.txt). Installs are reproducible.
  • examples
  • plotly_examples
  • pyvista_examples
  • sphinx_gallery
    Good: Test files detected (sphinx_gallery/tests).
  • tutorials
  • .git_archival.txt
  • .git-blame-ignore-revs
  • .gitattributes
  • .github_changelog_generator
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .yamllint.yml
  • CHANGES.rst
  • codecov.yml
  • LICENSE
    Good: Licensed under BSD-3-Clause.
  • MANIFEST.in
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.rst
    Good: README is present.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • RELEASES.md
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/sphinx-gallery/sphinx-gallery)](https://www.repo-grade.com/report/sphinx-gallery/sphinx-gallery)

More graded Python repos