djkurlander/knock-knock

0

/ 100

Documentation72
Engineering61
Health100
Python183MIT1d ago
Grade a repo

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

Knock-Knock: A Fun, Live View of Multi-Protocol Internet Break-in Attempts

Documentation

72

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 instructions9pt55

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

61

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

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/CD14pt68

CI is configured (.github/workflows/docker-publish.yml).

Tests18pt80

Test files detected (extras/tests).

Reproducibility6pt100

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

Project health

100

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

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)
  • 6
    Forks
  • 6
    Releaseslatest 1mo ago

Community

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

Responsiveness

  • 3h
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files38 root entries
  • .claude
  • .github
    Good: CI is configured (.github/workflows/docker-publish.yml).
    Good: Dependabot covers 3 ecosystems (pip, docker, github-actions). Dependencies stay current.
  • contrib
  • data
  • docs
  • extras
    Good: Test files detected (extras/tests).
  • honeypots
  • pix
  • protocols
  • static
  • systemd
  • tests
  • .dockerignore
  • .env.example
  • .gitignore
    Good: .gitignore present.
  • .gitleaks.toml
  • CLAUDE.md
  • constants.py
  • dbtool.py
  • docker-compose.override.yml.example
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • index.html
  • INSTALL.md
  • internet-background-radiation.html
  • ip_ban.py
  • LICENSE
    Good: Licensed under MIT.
  • main.py
  • monitor.py
  • protocol_api.py
  • 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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).
  • restart.sh
  • robots.txt
  • SECURITY.md
    Good: Security policy present.
  • sitemap.xml
  • stats.py
  • summary.html