0
/ 100
Exemplary work. Strong across engineering, project hygiene, and documentation.
Open-source signing device firmware for Bitcoin
Outstanding. A score of 96/100 puts this repo in a very small tier of truly well-engineered projects.
Top fixes
Highest-impact changes first, ranked by point weight
- 1Install and run instructions9pt
Add a .env.example listing all required environment variables so contributors know what to set up.
- 2Reproducibility6pt
Add .github/dependabot.yml with at least one package-ecosystem entry, or a renovate.json, so dependencies are updated automatically.
- 3Dependency manifest6pt
Add a [project.urls] table (Homepage, Repository) so PyPI links back to your project.
- 4Dependency manifest6pt
Add a [build-system] table (e.g. setuptools or hatchling) so the package can be built and published.
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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
94
Contributing guide is detailed and thorough.
README documents how to install the project.
README is present.
Licensed under Other.
Engineering
98
Lockfile present (uv.lock). Installs are reproducible.
Test files detected (tests).
CI is configured (.github/workflows/build.yml).
Linter or formatter configured (.pylintrc).
Issue or PR templates present.
Project health
96
Dependency manifest found (pyproject.toml).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- 3 / 46Commits (30d / 90d)
- 80Forks
- 19Releaseslatest 1y ago
Community
- 75% - GoodCommunity health
- 2 bus factorauthors own >50% of commits
- 368Watchers
Responsiveness
- 7d 9hMedian issue response
- 3hMedian PR merge time
- 74Open issues
Repository files28 root entries
- .githubGood: CI is configured (.github/workflows/build.yml).Good: Issue or PR templates present.
- docs
- firmware
- i18n
- overrides
- simulator
- src
- testsGood: Test files detected (tests).
- vendor
- .coveragerc
- .gitignoreGood: .gitignore present.
- .gitmodules
- .pylintrcGood: Linter or formatter configured (.pylintrc).
- CHANGELOG.md
- CONTRIBUTING.mdGood: Contributing guide is detailed and thorough.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.Good: Contributing guide describes the PR/review workflow.Good: Contributing guide includes code examples.
- DockerfileGood: Environment pinned via Dockerfile.
- krux
- LICENSE.mdGood: Licensed under Other.
- mkdocs.yml
- pyproject.tomlGood: Dependency manifest found (pyproject.toml).
- README.mdGood: 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.Good: README documents how to run the project.
- render_docs_math.py
- reproducibility.py
- SECURITY.mdGood: Security policy present.
- selfcustody.pem
- sign_release.py
- uv.lockGood: Lockfile present (uv.lock). Installs are reproducible.
- vulture_whitelist.py
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/selfcustody/krux)