Skip to main content

Add all the badges with Badgie!

Project description

Badgie

pipeline status coverage report latest release pre-commit security: bandit cici-tools enabled

Badgie scans the contents of your repository and adds badges based on what it finds.

Do not use this software unless you are an active collaborator on the associated research project.

This project is an output of an ongoing, active research project. It is published without warranty, is subject to change at any time, and has not been certified, tested, assessed, or otherwise assured of safety by any person or organization. Use at your own risk.

Using Badgie

Install Badgie:

python3 -m 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 -->

[![pipeline status](brettops/containers/verible/badges/main/pipeline.svg)](brettops/containers/verible/-/commits/main)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](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 "..."

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

badgie-0.12.0.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

badgie-0.12.0-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file badgie-0.12.0.tar.gz.

File metadata

  • Download URL: badgie-0.12.0.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for badgie-0.12.0.tar.gz
Algorithm Hash digest
SHA256 b0a807ffc433cc82fda3f647364b5dd45f73798c06273c3e5d3328f11ba0967f
MD5 e6451c0f7fddd187de7d2ba9f753ff03
BLAKE2b-256 536da5c6626f8d03800d316c9f3c1798a9f4ee9dd2bdbb355c18093b4235a233

See more details on using hashes here.

File details

Details for the file badgie-0.12.0-py3-none-any.whl.

File metadata

  • Download URL: badgie-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for badgie-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11d5a35cd180a6ba10c156a7e23ca08e845315fccf80373f4dfeed228cd6ddc5
MD5 22bc85758dbd814d06f6194c941c8871
BLAKE2b-256 d3c9cb10e6d2ec26a92ab890d10111ca814909dd7432e5c91dea59ac93b091ae

See more details on using hashes here.

Supported by

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