repo-kit
repo-kit is a tiny CLI that does two things:
- scan a repository and output a Repo Score (0-100) with actionable checks
- apply a "professional open-source kit" (README skeleton, License, contributing docs, GitHub templates, CI, Release, Changelog)
- badge to generate and embed a local score badge SVG + common GitHub badges
Goal: make repos look and feel professional in one command — without nuking existing files.
Install
pipx install repo-kit
# or
pip install repo-kit
Quickstart
# scan a local repo
repo-kit scan .
# scan a GitHub repo (clones to a temp dir)
repo-kit scan https://github.com/OWNER/REPO
# apply templates (safe by default: won't overwrite existing files)
repo-kit apply --stack python
# generate/update badges
repo-kit badge
Commands
repo-kit scan <path-or-github-url>
- prints a score and checklist
- can emit JSON for CI usage
repo-kit scan . --format json > repo-kit-report.json
repo-kit apply
Generates missing files and directories.
repo-kit apply --stack node
repo-kit apply --stack python --force # overwrite existing files
repo-kit badge
- creates
./.github/repo-score.svg - inserts badges into README (best-effort)
repo-kit badge --no-shields
Repo Score checks (v0.1)
- README presence + basic sections
- LICENSE
- CONTRIBUTING
- CODE_OF_CONDUCT
- Issue templates + PR template
- CI workflow
- Release workflow
- CHANGELOG
- Security policy stub
GitHub Action (example)
Put this in .github/workflows/repo-kit.yml:
name: repo-kit
on:
pull_request:
workflow_dispatch:
jobs:
scan:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- run: pip install repo-kit
- run: repo-kit scan . --format json > repo-kit-report.json
- uses: actions/upload-artifact@v4
with:
name: repo-kit-report
path: repo-kit-report.json
License
MIT
Metadata
Release files for repo-kit 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| repo_kit-0.1.0.tar.gz | 12.0 kB | Without provenance | Details for repo_kit-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| repo_kit-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for repo_kit-0.1.0-py3-none-any.whl |
Total release size: 28.2 kB
Release files / repo_kit-0.1.0.tar.gz
| Download URL | repo_kit-0.1.0.tar.gz |
|---|---|
| Size | 12.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6bbc263ff0e87e65929b4174169923e416e3da6138016ce5624698e1c7fab36c
|
|
BLAKE2b-256 checksum How to use checksums |
cac1d4c649ee2ca62a64dfae7721966c63661ad764d3ee95a3ab87d29a0589e8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.19
|
Release files / repo_kit-0.1.0-py3-none-any.whl
| Download URL | repo_kit-0.1.0-py3-none-any.whl |
|---|---|
| Size | 16.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
45a359abd5fa8d4b93f1bbf35e4bf7beb021839a7f6bb9c5a94bfe9fca59443f
|
|
BLAKE2b-256 checksum How to use checksums |
2d31735f4cfefad8bb18d15afe35ec6a7f58d8b60bb0fe37ec4486fc580d9aeb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.19
|
Security for repo-kit 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.