osuakatsuki/bancho.py

0

/ 100

Documentation61
Engineering68
Health100
Python279MIT1d ago
Grade a repo

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

The all-in-one osu! server backend for the general public. Simpler than the production Akatsuki stack, while maintaining core functionality.. plus a few unique features

Documentation

61

Contributing guide5pt5

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

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

README12pt68

README is present.

License6pt100

Licensed under MIT.

Engineering

68

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.

CI/CD14pt57

CI is configured (.github/workflows/lint.yaml).

Tests18pt80

Test files detected (tests).

Reproducibility6pt80

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

Issue and PR templates6pt100

Issue or PR templates present.

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)
  • 159
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 6h
    Median issue response
  • <1h
    Median PR merge time
  • 56
    Open issues
Repository files30 root entries
  • .devcontainer
  • .github
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/lint.yaml).
    Good: Issue or PR templates present.
    Good: Security policy present.
  • app
  • ext
  • migrations
  • scripts
  • testing
  • tests
    Good: Test files detected (tests).
  • tools
  • .coveragerc
  • .dockerignore
  • .env.example
  • .env.test
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • CODEOWNERS
  • docker-compose.cloudflared.yml
  • docker-compose.test.yml
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • LICENSE
    Good: Licensed under MIT.
  • logging.yaml.example
  • main.py
  • Makefile
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README_CN.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.
  • README_DE.MD
  • README_IT.md
  • README.md
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.