omerbibi/nopeeking-pdf
Grade a repo

0

/ 100

GradeB

Well engineered. The main gaps are issue and PR templates and a contributing guide. Impressive for a brand-new repo.

Top 22% of 5,156 graded repos

Remove highlighted answers from solved PDF exams.

Documentation78
Engineering85
Health98
Python0MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

8 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 .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry, or a renovate.json, so dependencies are updated automatically.

  4. 4
    Issue and PR templates6pt

    Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

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

78

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.

README12pt90

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

85

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.

Reproducibility6pt80

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

Tests18pt100

Test files detected (backend/tests).

CI/CD14pt100

CI is configured (.github/workflows/build-windows.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

  • -
    Commits (30d / 90d)
  • 0
    Forks
  • 3
    Releaseslatest 1mo ago

Community

  • 42% - Weak
    Community health
  • -
    authors own >50% of commits
  • 0
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/build-windows.yml).
  • assets
  • backend
    Good: Test files detected (backend/tests).
    Good: Environment pinned via backend/Dockerfile.
  • packaging
  • samples
  • src
  • tests
  • .gitignore
    Good: .gitignore present.
  • build_exe.py
  • CHANGELOG.md
  • LICENSE
    Good: Licensed under MIT.
  • main.py
  • NoPeeking.png
  • Preview.png
  • 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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • requirements-dev.txt
  • requirements.txt
    Good: Lockfile present (requirements.txt). 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/omerbibi/nopeeking-pdf)](https://www.repo-grade.com/report/omerbibi/nopeeking-pdf)

More graded Python repos