Skip to main content

Zero-dependency CLI to check a repository for missing files and manifest fields — README, LICENSE, .gitignore, CHANGELOG, and package metadata.

Project description

repogap

Zero-dependency CLI to check a repository for missing files and manifest fields — before you open-source it, add CI, or hand it off.

$ repogap

  ✓ README.md
  ✓ LICENSE
  ✓ .gitignore
  ! CHANGELOG  missing (recommended)

  pyproject.toml
    ✓ name         my-tool
    ✓ version      1.0.0
    ✗ description  missing or empty
    ✓ license      MIT

repogap: drift detected — 1 error, 1 warning

Install

pip install repogap

No dependencies. Python ≥ 3.8 required.

Usage

repogap [options] [dir]
Option Description
--strict Treat warnings as errors (exit 1)
--no-changelog Skip CHANGELOG check
--no-fields Skip manifest field checks
--json Machine-readable output
--version Print version
--help Show help

Exit codes: 0 clean · 1 issues found · 2 error

CI

- name: Check repo hygiene
  run: pip install repogap && repogap

For the Node.js counterpart, see repogap.

License

MIT

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

repogap-0.1.0.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

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

repogap-0.1.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for repogap-0.1.0.tar.gz
Algorithm Hash digest
SHA256 274fe0af243b65ca7d2c2fd0f9e150d7671f2ee083a29d1ae48546185a1d4a3f
MD5 b05005b54b9bfc42884d366b699300fd
BLAKE2b-256 cb76f997d1d39cebef162431a2f30f16079d6862da14511ba2285609bb6b7b3c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: repogap-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for repogap-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ced83fc2dd984aea4f46c5ed703fa7be42ebdd486400571b1b28c2fae57d5543
MD5 a34c98e55ff7dd084b3ac118a44fd80c
BLAKE2b-256 392a95632ea914f279842ddb6db60d0277e54586deb119fbc1ac002201eb8b18

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