# Badgie
<!-- BADGIE TIME -->
[](https://gitlab.com/buildgarden/tools/badgie/-/commits/main)
[](https://gitlab.com/buildgarden/tools/badgie/-/commits/main)
[](https://gitlab.com/buildgarden/tools/badgie/-/releases)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/PyCQA/bandit)
[](https://gitlab.com/buildgarden/tools/cici-tools)
<!-- END BADGIE TIME -->
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:
```bash
python3 -m pip install badgie
```
Add Badgie tags to your README:
```md
<!-- BADGIE TIME -->
<!-- END BADGIE TIME -->
```
Run Badgie:
```bash
badgie -w README.md
```
And enjoy magic badges:
```md
<!-- 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:
```yaml
repos:
- repo: https://gitlab.com/buildgarden/tools/badgie
rev: ""
hooks:
- id: badgie
```
Run `pre-commit autoupdate` to pin to the latest version:
```bash
pre-commit autoupdate
```
Run `pre-commit` directly or install as a hook:
```bash
# directly
pre-commit
# as a Git hook
pre-commit install
git commit -m "..."
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/buildgarden/tools/badgie",
"name": "badgie",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "badge,template,markdown",
"author": "Digital Safety Research Institute",
"author_email": "contact@dsri.org",
"download_url": "https://files.pythonhosted.org/packages/53/6d/a5c6626f8d03800d316c9f3c1798a9f4ee9dd2bdbb355c18093b4235a233/badgie-0.12.0.tar.gz",
"platform": null,
"description": "# Badgie\n\n<!-- BADGIE TIME -->\n\n[](https://gitlab.com/buildgarden/tools/badgie/-/commits/main)\n[](https://gitlab.com/buildgarden/tools/badgie/-/commits/main)\n[](https://gitlab.com/buildgarden/tools/badgie/-/releases)\n[](https://github.com/pre-commit/pre-commit)\n[](https://github.com/PyCQA/bandit)\n[](https://gitlab.com/buildgarden/tools/cici-tools)\n\n<!-- END BADGIE TIME -->\n\nBadgie scans the contents of your repository and adds badges based on what it\nfinds.\n\n> Do not use this software unless you are an active collaborator on the\n> associated research project.\n>\n> This project is an output of an ongoing, active research project. It is\n> published without warranty, is subject to change at any time, and has not been\n> certified, tested, assessed, or otherwise assured of safety by any person or\n> organization. Use at your own risk.\n\n## Using Badgie\n\nInstall Badgie:\n\n```bash\npython3 -m pip install badgie\n```\n\nAdd Badgie tags to your README:\n\n```md\n<!-- BADGIE TIME -->\n<!-- END BADGIE TIME -->\n```\n\nRun Badgie:\n\n```bash\nbadgie -w README.md\n```\n\nAnd enjoy magic badges:\n\n```md\n<!-- BADGIE TIME -->\n\n[](brettops/containers/verible/-/commits/main)\n[](https://github.com/pre-commit/pre-commit)\n\n<!-- END BADGIE TIME -->\n```\n\n### Use as a pre-commit hook\n\nBadgie can be used as a pre-commit hook, so you can get fresh badges on every\ncommit.\n\nAdd the following to a `.pre-commit-config.yaml` file. Note the empty\n`rev` tag:\n\n```yaml\nrepos:\n - repo: https://gitlab.com/buildgarden/tools/badgie\n rev: \"\"\n hooks:\n - id: badgie\n```\n\nRun `pre-commit autoupdate` to pin to the latest version:\n\n```bash\npre-commit autoupdate\n```\n\nRun `pre-commit` directly or install as a hook:\n\n```bash\n# directly\npre-commit\n\n# as a Git hook\npre-commit install\ngit commit -m \"...\"\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Add all the badges with Badgie!",
"version": "0.12.0",
"project_urls": {
"Homepage": "https://gitlab.com/buildgarden/tools/badgie"
},
"split_keywords": [
"badge",
"template",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3c9cb10e6d2ec26a92ab890d10111ca814909dd7432e5c91dea59ac93b091ae",
"md5": "22bc85758dbd814d06f6194c941c8871",
"sha256": "11d5a35cd180a6ba10c156a7e23ca08e845315fccf80373f4dfeed228cd6ddc5"
},
"downloads": -1,
"filename": "badgie-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22bc85758dbd814d06f6194c941c8871",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 18529,
"upload_time": "2024-03-18T18:50:14",
"upload_time_iso_8601": "2024-03-18T18:50:14.017064Z",
"url": "https://files.pythonhosted.org/packages/d3/c9/cb10e6d2ec26a92ab890d10111ca814909dd7432e5c91dea59ac93b091ae/badgie-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "536da5c6626f8d03800d316c9f3c1798a9f4ee9dd2bdbb355c18093b4235a233",
"md5": "e6451c0f7fddd187de7d2ba9f753ff03",
"sha256": "b0a807ffc433cc82fda3f647364b5dd45f73798c06273c3e5d3328f11ba0967f"
},
"downloads": -1,
"filename": "badgie-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "e6451c0f7fddd187de7d2ba9f753ff03",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12897,
"upload_time": "2024-03-18T18:50:15",
"upload_time_iso_8601": "2024-03-18T18:50:15.430790Z",
"url": "https://files.pythonhosted.org/packages/53/6d/a5c6626f8d03800d316c9f3c1798a9f4ee9dd2bdbb355c18093b4235a233/badgie-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 18:50:15",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "buildgarden",
"gitlab_project": "tools",
"lcname": "badgie"
}
JSON