Skip to main content

GitHub repo launch-readiness auditor — signals your repo is missing for public discoverability.

Project description

repo-audit: GitHub repo launch-readiness checker

License Python 3.10+ CI

Your repo works locally. Now what? Most repos stay invisible not because the code is bad, but because no topics are set, no PyPI page exists, the README is three lines, and nobody has ever posted it anywhere.

repo-audit measures that gap in under 30 seconds and gives you a ranked to-do list you can act on immediately.

  • "My repo has 0 stars and I don't know where to start."
  • "I pushed a tool but it doesn't show up in GitHub search."
  • "I want a quick audit before sharing a repo publicly."
  • "I need to know what's missing before submitting to an awesome-* list."
  • "I want to verify my launch checklist is actually done."

Install

pip install repo-audit

Requires Python 3.10+. No GitHub token needed.

Quick Start

repo-audit github.com/psf/black

Exact Outcome

repo-audit: github.com/psf/black
  Score: 91/100  Grade: A  (12.3s)

  PASS  README Quality         100/100
  PASS  Repo Metadata          100/100
  PASS  Social Proof           100/100
  PASS  Release Cadence        100/100
  PASS  Docs & Agent Files      90/100
  PASS  Distribution (PyPI/npm) 100/100
  PASS  Web Discoverability    100/100
  FAIL  Topical Citations       40/100
  WARN  Launch Channels         75/100

Top actions:
  [Topical Citations] Post 'Show HN: black — ...' at news.ycombinator.com.
  [Launch Channels] Submit a PR to the relevant awesome-* list.

Other Flags

# JSON output for scripting or CI
repo-audit github.com/psf/black --json

# Verbose: show per-signal findings and source URLs
repo-audit github.com/psf/black --verbose

Signal Categories

Signal Weight What it checks
README Quality 15% length, quickstart, badges, license mention
Repo Metadata 12% description, topics, homepage
Social Proof 10% stars, forks, commit recency
Release Cadence 8% GitHub releases and tags
Docs & Agent Files 10% AGENTS.md, llms.txt, CONTRIBUTING, CHANGELOG
Distribution 15% PyPI or npm presence
Web Discoverability 12% DDG: does repo appear in top search results?
Topical Citations 10% DDG: HN, Reddit, arXiv site: queries
Launch Channels 8% awesome-* lists, DEV.to articles

When To Use It

  • Before sharing a repo publicly (Show HN, blog post, tweet)
  • Before submitting to an awesome-* list
  • As a lightweight pre-launch CI check
  • When auditing an existing repo to find quick wins

When Not To Use It

  • To audit private repos (GitHub public API only, by design)
  • To check code quality (use a linter for that)
  • When you need proof of correctness, not a discoverability signal

Provenance Gate

Every signal in the output cites the GitHub API URL or search result URL it was derived from. No fabricated scores. When a signal can't be found (e.g. a private repo), the tool returns an honest null and cites the empty source URL.

Python API

from repo_audit.audit import run_audit
from repo_audit.formatter import format_text

report = run_audit("github.com/psf/black")
print(report.overall_score)   # int 0-100
print(report.grade)           # "A" | "B" | "C" | "D" | "F"
print(report.top_actions)     # list[str] ranked action items

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hermes_repo_audit-0.1.0.tar.gz (135.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hermes_repo_audit-0.1.0-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

Details for the file hermes_repo_audit-0.1.0.tar.gz.

File metadata

  • Download URL: hermes_repo_audit-0.1.0.tar.gz
  • Upload date:
  • Size: 135.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for hermes_repo_audit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3030d0f0f72424c74eb60231a528e9b8a10209a0f7c54402dd739c0cd9d0b47e
MD5 7dd21ea03b42e91cdb7ca9196010dd0d
BLAKE2b-256 d20f6bafc093d238d00bd73144e557ea7c12ddb9cffaec20ed829e58acc78da8

See more details on using hashes here.

File details

Details for the file hermes_repo_audit-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for hermes_repo_audit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef71d2c5f6dfae1e0ca8f96d553a810a34d4254563fbf73a909f7ef25084ff02
MD5 4fbdf37fcd43e61202cb0fb97fffae6a
BLAKE2b-256 89484186b37e76aa2871bdc25c76edf1bf5c6c67722c854653e6b2ca1e7fe2cb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page