From 96300c3e29c9b44bee4595b6a86c70eca70a7012 Mon Sep 17 00:00:00 2001 From: johnthagen Date: Thu, 5 Mar 2026 13:47:41 -0500 Subject: [PATCH 1/2] Add a python-blueprint badge --- README.md | 14 ++++++++++++++ docs/index.md | 3 +++ 2 files changed, 17 insertions(+) diff --git a/README.md b/README.md index c506b045..62ea5af2 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,14 @@ [![Nox][nox-badge]](https://github.com/wntrblm/nox) [![Ruff][ruff-badge]](https://github.com/astral-sh/ruff) [![Type checked with mypy][mypy-badge]](https://mypy-lang.org/) +[![Python Blueprint][python-blueprint-badge]](https://github.com/johnthagen/python-blueprint) [github-actions-badge]: https://github.com/johnthagen/python-blueprint/actions/workflows/ci.yml/badge.svg [uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json [nox-badge]: https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg [ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json [mypy-badge]: https://www.mypy-lang.org/static/mypy_badge.svg +[python-blueprint-badge]: https://img.shields.io/badge/%F0%9F%97%BA-python--blueprint-2dcf59.svg Example Python project that demonstrates how to create a Python package using the latest Python testing, linting, and type checking tooling. The project contains a `fact` package that @@ -466,6 +468,18 @@ fact v1.0.0 └── shellingham v1.5.4 (extra: standard) ``` +# `python-blueprint` Badge + +Support [`python-blueprint`](https://github.com/johnthagen/python-blueprint) by adding the badge +to your project: + +[![Python Blueprint][python-blueprint-badge]](https://github.com/johnthagen/python-blueprint) + +```md +[![Python Blueprint][python-blueprint-badge]](https://github.com/johnthagen/python-blueprint) +[python-blueprint-badge]: https://img.shields.io/badge/%F0%9F%97%BA-python--blueprint-2dcf59.svg +``` + # PyCharm Configuration > [!TIP] diff --git a/docs/index.md b/docs/index.md index 811fe36d..d18a8a25 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,6 +5,9 @@ status: new # `fact` User Guide +[![Python Blueprint][python-blueprint-badge]](https://github.com/johnthagen/python-blueprint) +[python-blueprint-badge]: https://img.shields.io/badge/%F0%9F%97%BA-python--blueprint-2dcf59.svg + ??? info "`python-blueprint` Project" For more information on how this was built and deployed, as well as other Python best From b130dcc1edb463832fef1cc2c2d103a9b1c54a25 Mon Sep 17 00:00:00 2001 From: johnthagen Date: Thu, 5 Mar 2026 13:50:27 -0500 Subject: [PATCH 2/2] Add an admonition --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 62ea5af2..09b55caf 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,9 @@ provides a simple implementation of the [factorial algorithm](https://en.wikipedia.org/wiki/Factorial) (`fact.lib`) and a command line interface (`fact.cli`). +> [!TIP] +> Support `python-blueprint` by adding a [badge](#badge). + # Package Management This package uses [uv](https://docs.astral.sh/uv/) to manage dependencies and @@ -468,7 +471,7 @@ fact v1.0.0 └── shellingham v1.5.4 (extra: standard) ``` -# `python-blueprint` Badge +# Badge Support [`python-blueprint`](https://github.com/johnthagen/python-blueprint) by adding the badge to your project: