thecont1/traffic-monitor-lizard

0

/ 100

Documentation70
Engineering51
Health93
Jupyter Notebook8Other1d ago
Grade a repo

Early stage. Tests, CI, and a strong README would raise this score quickly.

A system to monitor and analyse road traffic flow on pre-determined routes within a city.

Documentation

70

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.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

51

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.

CI/CD14pt40

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

Reproducibility6pt70

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

Tests18pt85

Test files detected (tests).

Project health

93

Dependency manifest6pt79

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
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 8
    Watchers

Responsiveness

  • —
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files26 root entries
  • .github
    Good: CI is configured (.github/workflows/traffic_snapshot.yml).
  • config
  • data
  • docs
  • images
  • tests
    Good: Test files detected (tests).
  • tools
  • workers
  • .gitignore
    Good: .gitignore present.
  • data_utils.py
  • generate_mapshots.py
  • generate_rrs_exports.py
  • LICENSE_CODE.md
  • LICENSE_DATA.md
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    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.
  • routes.html
  • routes.png
  • rrs_scoring.py
  • traffic_analysis_examples.ipynb
  • traffic_analysis_report.html
  • traffic_analyzer.py
  • traffic_snapshot.ipynb
  • traffic_visual.ipynb
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.
  • visualization_engine.py