simonw/shot-scraper

0

/ 100

Documentation74
Engineering64
Health100
Python2,374Apache-2.01d ago
Grade a repo

Good community traction and solid fundamentals. Nearly in the top tier.

A command-line utility for taking automated screenshots of websites

Documentation

74

Install and run instructions9pt45

README documents how to install the project.

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.

README12pt85

README is present.

License6pt100

Licensed under Apache-2.0.

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.

Reproducibility6pt70

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

Tests18pt85

Test files detected (tests).

CI/CD14pt85

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

Project health

100

Dependency manifest6pt100

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)
  • 118
    Forks
  • 35
    Releaseslatest 4y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 2,374
    Watchers

Responsiveness

  • <1h
    Median issue response
  • 7d 6h
    Median PR merge time
  • 55
    Open issues
Repository files9 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
  • 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.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    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.
    Good: Lockfile present (docs/requirements.txt). Installs are reproducible.
  • shot_scraper
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • .readthedocs.yaml
  • LICENSE
    Good: Licensed under Apache-2.0.
  • 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.
    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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.