Skip to content

Commit bccd32e

Browse files
authored
Merge pull request #4 from Pymetheus/develop
docs: Update badges in README and checklist install command
2 parents 84c1913 + 393795c commit bccd32e

2 files changed

Lines changed: 30 additions & 3 deletions

File tree

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,37 @@
11
# Python Project Blueprint
22

3+
[![Mypy][mypy-badge]](https://mypy-lang.org)
4+
[![Ruff][ruff-badge]](https://github.com/astral-sh/ruff)
5+
[![Pytest][pytest-badge]](https://docs.pytest.org/en/stable/)
6+
[![Bandit][bandit-badge]](https://github.com/PyCQA/bandit)
7+
[![Snyk][snyk-badge]](https://snyk.io)
38
[![Python Version][python-badge]](https://www.python.org/)
49
[![License][license-badge]](LICENSE.md)
510

6-
[python-badge]: https://img.shields.io/badge/python-3.12%2B-blue?color=4180b2
7-
[license-badge]: https://img.shields.io/github/license/pymetheus/python-project-blueprint?color=4180b2
11+
[![Pre-commit][pre-commit-badge]](https://github.com/pre-commit/pre-commit)
12+
[![PR Checks][pr-badge]](https://github.com/Pymetheus/python-project-blueprint/actions/workflows/pr-checks.yml)
13+
[![Security][security-badge]](https://github.com/Pymetheus/python-project-blueprint/actions/workflows/security.yml)
14+
[![CI][ci-badge]](https://github.com/Pymetheus/python-project-blueprint/actions/workflows/ci.yml)
15+
[![CD][cd-badge]](https://github.com/Pymetheus/python-project-blueprint/actions/workflows/cd.yml)
16+
17+
[![Bootstrap][bootstrap-badge]](https://github.com/Pymetheus/python-project-blueprint/actions/workflows/bootstrap.yml)
18+
[![Template][use-template-badge]](https://github.com/new?template_name=python-project-blueprint&template_owner=Pymetheus)
19+
20+
[mypy-badge]: https://img.shields.io/badge/mypy-checked-4180b1
21+
[ruff-badge]: https://img.shields.io/badge/ruff-linted-4180b1
22+
[pytest-badge]: https://img.shields.io/badge/pytest-tested-4180b1
23+
[bandit-badge]: https://img.shields.io/badge/bandit-scanned-4180b1
24+
[snyk-badge]: https://img.shields.io/badge/snyk-scanned-4180b1
25+
[python-badge]: https://img.shields.io/badge/python-3.12%2B-blue?color=4180b1
26+
[license-badge]: https://img.shields.io/github/license/Pymetheus/python-project-blueprint?color=4180b1
27+
[pre-commit-badge]: https://img.shields.io/badge/pre--commit-enabled-31c553?logo=pre-commit&logoColor=white
28+
[pr-badge]: https://github.com/Pymetheus/python-project-blueprint/actions/workflows/pr-checks.yml/badge.svg
29+
[security-badge]: https://github.com/Pymetheus/python-project-blueprint/actions/workflows/security.yml/badge.svg
30+
[ci-badge]: https://github.com/Pymetheus/python-project-blueprint/actions/workflows/ci.yml/badge.svg
31+
[cd-badge]: https://github.com/Pymetheus/python-project-blueprint/actions/workflows/cd.yml/badge.svg
32+
[bootstrap-badge]: https://github.com/Pymetheus/python-project-blueprint/actions/workflows/bootstrap.yml/badge.svg
33+
[use-template-badge]: https://img.shields.io/badge/Use%20this%20template-006222
34+
835

936
A **production-ready Python project template** designed to remove setup friction and enforce best practices from the very first commit.
1037

docs/CHECKLIST.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ install your project using the package manager of your choice:
5050

5151
- [ ] **USER:** Install dependencies using **pip**, **uv**, or **poetry**:
5252
- `pip install -e ".[dev]"`.
53-
- `uv install -e ".[dev]"`.
53+
- `uv pip install -e ".[dev]"`.
5454
- `poetry install --extras dev`.
5555
- [ ] **USER:** Run `pre-commit install`.
5656
- [ ] **USER:** Run the application `python -m <package_name>.main`.

0 commit comments

Comments
 (0)