python-lib-template/pyproject.toml at main · LilianBsc/python-lib-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "my_lib"
dynamic = ["version"]
description = "A brief description of the project."
authors = [
    { name="Your Name", email="your.email@example.com" }
]
readme = "README.md"
license = { file="LICENSE" }
requires-python = ">=3.8"
dependencies = [
    "numpy"
]

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

[tool.hatch.envs.default]
dependencies = [
    "ruff",
    "pytest",
]

# # Linting configuration
[tool.ruff]
line-length = 88
lint.select = ["E", "F", "W"]
lint.ignore = ["E501"]

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401"]

# Tests
# [tool.pytest.ini_options]
# addopts = "-ra -q"

# General scripts
[tool.hatch.envs.default.scripts]
lint = "ruff check ."
test = "pytest"

# Doc
[tool.hatch.envs.doc]
dependencies = [
    "mkdocs",
    "mkdocstrings-python"
]

[tool.hatch.envs.doc.scripts]
serve = "mkdocs serve"
deploy = "mkdocs gh-deploy"