Skip to content

Commit 83975b8

Browse files
Refine repository for professional standards
This commit applies final polishing touches to the repository to ensure it meets the highest standards of a professional Python package. - Updated the `README.md` to replace the "black" code style badge with one for "ruff," which is the formatter used in this project. - Added a `[tool.ruff]` configuration to `pyproject.toml` to ensure consistent and explicit behavior.
1 parent 7cb1b94 commit 83975b8

2 files changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Build Status](https://img.shields.io/github/actions/workflow/status/[USERNAME]/[REPO_NAME]/ci-cd.yml?branch=main)](https://github.com/[USERNAME]/[REPO_NAME]/actions/workflows/ci-cd.yml)
55
[![Codecov](https://img.shields.io/codecov/c/github/[USERNAME]/[REPO_NAME])](https://codecov.io/gh/[USERNAME]/[REPO_NAME])
66
[![License](https://img.shields.io/badge/License-Prosperity%203.0.0-blue.svg)](LICENSE)
7-
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
7+
[![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
88
[![Python Versions](https://img.shields.io/pypi/pyversions/my_python_project)](https://pypi.org/project/my_python_project)
99

1010
This is a best-in-class Python package template.

pyproject.toml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,16 @@ build-backend = "poetry.core.masonry.api"
4141

4242
[tool.pytest.ini_options]
4343
addopts = "--cov=src --cov-report=xml"
44+
45+
[tool.ruff]
46+
line-length = 88
47+
indent-width = 4
48+
49+
[tool.ruff.lint]
50+
select = ["E4", "E7", "E9", "F", "I"]
51+
52+
[tool.ruff.format]
53+
quote-style = "double"
54+
indent-style = "space"
55+
skip-magic-trailing-comma = false
56+
line-ending = "lf"

0 commit comments

Comments
 (0)