Skip to content

Commit 22322a7

Browse files
committed
README.md update
Signed-off-by: Federico Busetti <729029+febus982@users.noreply.github.com>
1 parent 324105d commit 22322a7

File tree

2 files changed

+5
-8
lines changed

2 files changed

+5
-8
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,21 @@
44
[![stability-beta](https://img.shields.io/badge/stability-beta-33bbff.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#beta)
55

66
[![Python tests](https://github.com/febus982/bootstrap-python-package/actions/workflows/python-tests.yml/badge.svg?branch=main)](https://github.com/febus982/bootstrap-python-package/actions/workflows/python-tests.yml)
7-
[![Bandit checks](https://github.com/febus982/bootstrap-python-package/actions/workflows/python-bandit.yml/badge.svg?branch=main)](https://github.com/febus982/bootstrap-python-package/actions/workflows/python-bandit.yml)
87
[![Maintainability](https://api.codeclimate.com/v1/badges/593e78ec96ed5ebb0dd3/maintainability)](https://codeclimate.com/github/febus982/bootstrap-python-package/maintainability)
98
[![Test Coverage](https://api.codeclimate.com/v1/badges/593e78ec96ed5ebb0dd3/test_coverage)](https://codeclimate.com/github/febus982/bootstrap-python-package/test_coverage)
109

1110
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
12-
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1311
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
12+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1413
[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
1514

1615
This template repository provides the boilerplate to create a python package.
1716
It is configured with all the following features:
1817

1918
* Test suite using [tox](https://tox.wiki/en/latest/index.html) and [pytest](https://docs.pytest.org/en/7.4.x/)
2019
* Typing using [mypy](https://mypy.readthedocs.io/en/stable/)
21-
* Linting using [ruff](https://github.com/astral-sh/ruff)
22-
* Code formatter using [black](https://pypi.org/project/black/)
23-
* Security checks using [bandit](https://github.com/PyCQA/bandit)
20+
* Linting, security and code format using [ruff](https://github.com/astral-sh/ruff) (using [black](https://pypi.org/project/black/)
21+
code style and [bandit](https://github.com/PyCQA/bandit) security rules)
2422
* Integration with CodeClimate for code quality and coverage checks
2523
* CI pipeline supporting:
2624
* testing against multiple python versions

docs/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@ It is configured with all the following features:
55

66
* Test suite using [pytest](https://docs.pytest.org/en/7.4.x/)
77
* Typing using [mypy](https://mypy.readthedocs.io/en/stable/)
8-
* Linting using [ruff](https://github.com/astral-sh/ruff)
9-
* Code formatter using [black](https://pypi.org/project/black/)
10-
* Security checks using [bandit](https://github.com/PyCQA/bandit)
8+
* Linting, security and code format using [ruff](https://github.com/astral-sh/ruff) (using [black](https://pypi.org/project/black/)
9+
code style and [bandit](https://github.com/PyCQA/bandit) security rules)
1110
* Integration with CodeClimate for code quality and coverage checks
1211
* CI pipeline supporting:
1312
* testing against multiple python versions

0 commit comments

Comments
 (0)