~docbibi/ysort

f5052e0302dd22a1bfc726444f2c1287fe32737b — Borjan Tchakaloff 10 months ago 4f245b3
Create boilerplate with Hatch
5 files changed, 176 insertions(+), 0 deletions(-)

A LICENSE.txt
A pyproject.toml
A src/ysort/__about__.py
A src/ysort/__init__.py
A tests/__init__.py
A LICENSE.txt => LICENSE.txt +9 -0
@@ 0,0 1,9 @@
MIT License

Copyright (c) 2023-present Borjan Tchakaloff <borjan@tchakaloff.fr>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

A pyproject.toml => pyproject.toml +157 -0
@@ 0,0 1,157 @@
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "ysort"
dynamic = ["version"]
description = ''
readme = "README.md"
requires-python = ">=3.8"
license = "MIT"
keywords = []
authors = [
  { name = "Borjan Tchakaloff", email = "borjan@tchakaloff.fr" },
]
classifiers = [
  "Development Status :: 4 - Beta",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3.8",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: Implementation :: CPython",
  "Programming Language :: Python :: Implementation :: PyPy",
]
dependencies = []

[project.urls]
Documentation = "https://sr.ht/docbibi/ysort#readme"
Issues = "https://sr.ht/docbibi/ysort/issues"
Source = "https://sr.ht/docbibi/ysort"

[tool.hatch.version]
path = "src/ysort/__about__.py"

[tool.hatch.envs.default]
dependencies = [
  "coverage[toml]>=6.5",
  "pytest",
]
[tool.hatch.envs.default.scripts]
test = "pytest {args:tests}"
test-cov = "coverage run -m pytest {args:tests}"
cov-report = [
  "- coverage combine",
  "coverage report",
]
cov = [
  "test-cov",
  "cov-report",
]

[[tool.hatch.envs.all.matrix]]
python = ["3.8", "3.9", "3.10", "3.11", "3.12"]

[tool.hatch.envs.lint]
detached = true
dependencies = [
  "black>=23.1.0",
  "mypy>=1.0.0",
  "ruff>=0.0.243",
]
[tool.hatch.envs.lint.scripts]
typing = "mypy --install-types --non-interactive {args:src/ysort tests}"
style = [
  "ruff {args:.}",
  "black --check --diff {args:.}",
]
fmt = [
  "black {args:.}",
  "ruff --fix {args:.}",
  "style",
]
all = [
  "style",
  "typing",
]

[tool.black]
target-version = ["py38"]
line-length = 120
skip-string-normalization = true

[tool.ruff]
target-version = "py38"
line-length = 120
select = [
  "A",
  "ARG",
  "B",
  "C",
  "DTZ",
  "E",
  "EM",
  "F",
  "FBT",
  "I",
  "ICN",
  "ISC",
  "N",
  "PLC",
  "PLE",
  "PLR",
  "PLW",
  "Q",
  "RUF",
  "S",
  "T",
  "TID",
  "UP",
  "W",
  "YTT",
]
ignore = [
  # Allow non-abstract empty methods in abstract base classes
  "B027",
  # Allow boolean positional values in function calls, like `dict.get(... True)`
  "FBT003",
  # Ignore checks for possible passwords
  "S105", "S106", "S107",
  # Ignore complexity
  "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
]
unfixable = [
  # Don't touch unused imports
  "F401",
]

[tool.ruff.isort]
known-first-party = ["ysort"]

[tool.ruff.flake8-tidy-imports]
ban-relative-imports = "all"

[tool.ruff.per-file-ignores]
# Tests can use magic values, assertions, and relative imports
"tests/**/*" = ["PLR2004", "S101", "TID252"]

[tool.coverage.run]
source_pkgs = ["ysort", "tests"]
branch = true
parallel = true
omit = [
  "src/ysort/__about__.py",
]

[tool.coverage.paths]
ysort = ["src/ysort", "*/ysort/src/ysort"]
tests = ["tests", "*/ysort/tests"]

[tool.coverage.report]
exclude_lines = [
  "no cov",
  "if __name__ == .__main__.:",
  "if TYPE_CHECKING:",
]

A src/ysort/__about__.py => src/ysort/__about__.py +4 -0
@@ 0,0 1,4 @@
# SPDX-FileCopyrightText: 2023-present Borjan Tchakaloff <borjan@tchakaloff.fr>
#
# SPDX-License-Identifier: MIT
__version__ = "0.0.1"

A src/ysort/__init__.py => src/ysort/__init__.py +3 -0
@@ 0,0 1,3 @@
# SPDX-FileCopyrightText: 2023-present Borjan Tchakaloff <borjan@tchakaloff.fr>
#
# SPDX-License-Identifier: MIT

A tests/__init__.py => tests/__init__.py +3 -0
@@ 0,0 1,3 @@
# SPDX-FileCopyrightText: 2023-present Borjan Tchakaloff <borjan@tchakaloff.fr>
#
# SPDX-License-Identifier: MIT