Skip to content

Commit 832085b

Browse files
authored
Add a python-blueprint badge (#339)
1 parent 8e5925b commit 832085b

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,24 @@
55
[![Nox][nox-badge]](https://github.com/wntrblm/nox)
66
[![Ruff][ruff-badge]](https://github.com/astral-sh/ruff)
77
[![Type checked with mypy][mypy-badge]](https://mypy-lang.org/)
8+
[![Python Blueprint][python-blueprint-badge]](https://github.com/johnthagen/python-blueprint)
89

910
[github-actions-badge]: https://github.com/johnthagen/python-blueprint/actions/workflows/ci.yml/badge.svg
1011
[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json
1112
[nox-badge]: https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg
1213
[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
1314
[mypy-badge]: https://www.mypy-lang.org/static/mypy_badge.svg
15+
[python-blueprint-badge]: https://img.shields.io/badge/%F0%9F%97%BA-python--blueprint-2dcf59.svg
1416

1517
Example Python project that demonstrates how to create a Python package using the latest
1618
Python testing, linting, and type checking tooling. The project contains a `fact` package that
1719
provides a simple implementation of the
1820
[factorial algorithm](https://en.wikipedia.org/wiki/Factorial) (`fact.lib`) and a command line
1921
interface (`fact.cli`).
2022

23+
> [!TIP]
24+
> Support `python-blueprint` by adding a [badge](#badge).
25+
2126
# Package Management
2227

2328
This package uses [uv](https://docs.astral.sh/uv/) to manage dependencies and
@@ -466,6 +471,18 @@ fact v1.0.0
466471
└── shellingham v1.5.4 (extra: standard)
467472
```
468473

474+
# Badge
475+
476+
Support [`python-blueprint`](https://github.com/johnthagen/python-blueprint) by adding the badge
477+
to your project:
478+
479+
[![Python Blueprint][python-blueprint-badge]](https://github.com/johnthagen/python-blueprint)
480+
481+
```md
482+
[![Python Blueprint][python-blueprint-badge]](https://github.com/johnthagen/python-blueprint)
483+
[python-blueprint-badge]: https://img.shields.io/badge/%F0%9F%97%BA-python--blueprint-2dcf59.svg
484+
```
485+
469486
# PyCharm Configuration
470487

471488
> [!TIP]

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ status: new
55

66
# `fact` User Guide
77

8+
[![Python Blueprint][python-blueprint-badge]](https://github.com/johnthagen/python-blueprint)
9+
[python-blueprint-badge]: https://img.shields.io/badge/%F0%9F%97%BA-python--blueprint-2dcf59.svg
10+
811
??? info "`python-blueprint` Project"
912

1013
For more information on how this was built and deployed, as well as other Python best

0 commit comments

Comments
 (0)