Skip to main content

Badgie

pipeline status coverage report latest release pre-commit security: bandit cici enabled code style: prettier

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

Badgie requires Git and will only run in Git repositories.

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 -->
<!-- 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/saferatday0/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 "..."

Metadata

Release files for badgie 0.15.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for badgie 0.15.2
File Size Uploaded Provenance
badgie-0.15.2.tar.gz 18.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for badgie 0.15.2
File Interpreter ABI Platform
badgie-0.15.2-py3-none-any.whl Python 3 none any Details

Total release size: 40.6 kB

Release files / badgie-0.15.2.tar.gz

Download URL badgie-0.15.2.tar.gz
Size 18.1 kB
Tags Source
SHA-256 checksum
How to use checksums
b46a210fe96d86e83c2ba662ffe17a4ab2cf77f80d1d06fd39ff3568a9a33efb
BLAKE2b-256 checksum
How to use checksums
c7509adfc885b160c9737d01bbcc2bfb3b5cf85bee7fd7479e1600668ec7bd0f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.2.0 CPython/3.11.14

Release files / badgie-0.15.2-py3-none-any.whl

Download URL badgie-0.15.2-py3-none-any.whl
Size 22.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6e8f5c0d69c5ed6ba9693769817647d149e68bb8239f639c1c77d9a26f7cd195
BLAKE2b-256 checksum
How to use checksums
237c37d5e402289f03f71b9e43bdf83f48432a4da7ea0e1401e3fafeb0c1f854
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.2.0 CPython/3.11.14

Security for badgie 0.15.2

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page