vpython/vpython-jupyter
Grade a repo

0

/ 100

GradeC

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

Top 45% of 5,156 graded repos

3D visualization made easy

Documentation82
Engineering64
Health72
Python163MIT8mo ago

Top fixes

Highest-impact changes first, ranked by point weight

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

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

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

82

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.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

64

Linting and formatting5pt0

No linter or formatter configured.

→ Add [tool.ruff] to pyproject.toml. Ruff handles linting and formatting in one tool and replaces flake8, isort, and black.

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.

Tests18pt80

Test files detected (vpython/test).

Reproducibility6pt82

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

CI/CD14pt85

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

Project health

72

Activity5pt40

Last pushed 6-12 months ago (−60 pts).

→ A recent commit signals the project is still maintained.

Dependency manifest6pt62

Dependency manifest found (pyproject.toml).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 63
    Forks
  • 54
    Releaseslatest 6y ago

Community

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

Responsiveness

  • 6h
    Median issue response
  • 2h
    Median PR merge time
  • 31
    Open issues
Repository files25 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot configured for github-actions.
  • CythonBuild
  • Demos
  • Demos_no_notebook
  • labextension
  • vpython
    Good: Test files detected (vpython/test).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • CHANGES.txt
  • CONTRIBUTORS.md
  • convert_stl.zip
  • drive_copy.py
  • index.ipynb
  • JupyterPythonDemos.zip
  • LICENSE.txt
    Good: Licensed under MIT.
  • MANIFEST.in
  • 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • RELEASE.md
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
  • setup.cfg
  • setup.py
  • vp_copy.yaml
  • VPythonDemos_no_notebook.zip
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/vpython/vpython-jupyter)](https://www.repo-grade.com/report/vpython/vpython-jupyter)

More graded Python repos