Add all the badges with Badgie!
Project description
Badgie
Add all the badges with Badgie!
Using Badgie
Install Badgie:
pip install badgie
Add Badgie tags to your README:
<!-- BADGIE TIME -->
<!-- END BADGIE TIME -->
Run Badgie:
badgie -w README.md
And enjoy magic badges:
<!-- BADGIE TIME -->
[](brettops/containers/verible/-/commits/main)
[](https://github.com/pre-commit/pre-commit)
<!-- END BADGIE TIME -->
Use as a pre-commit hook
Badgie can be used as a pre-commit hook, so you can get fresh badges on every commit.
Add the following to a .pre-commit-config.yaml file. Note the empty
rev tag:
repos:
- repo: https://gitlab.com/buildgarden/tools/badgie
rev: ""
hooks:
- id: badgie
Run pre-commit autoupdate to pin to the latest version:
pre-commit autoupdate
Run pre-commit directly or install as a hook:
# directly
pre-commit
# as a Git hook
pre-commit install
git commit -m "..."
Caveats
Badgie makes decisions on the assumption that you do sensible things with your repository structure. It does not try to work around bad practices. MRs that encourage this will be rejected.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
badgie-0.11.0.tar.gz
(12.7 kB
view hashes)
Built Distribution
badgie-0.11.0-py3-none-any.whl
(18.5 kB
view hashes)
