forked from docsible/docsible
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpyproject.toml
More file actions
165 lines (146 loc) · 4.7 KB
/
pyproject.toml
File metadata and controls
165 lines (146 loc) · 4.7 KB
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# Standard Python project metadata (PEP 621) - works with uv, pip, pyenv
[project]
name = "docsible"
version = "0.9.0"
description = "Document generator for ansible role/collection"
readme = "README.md"
requires-python = ">=3.10"
license = {text = "MIT"}
authors = [
{name = "Lucian BLETAN", email = "neuraluc@gmail.com"}
]
keywords = ["ansible", "documentation", "roles", "collections", "readme", "markdown"]
classifiers = [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: POSIX",
"Operating System :: MacOS",
"Operating System :: Unix",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: Software Development :: Documentation",
"Topic :: System :: Systems Administration",
]
# =========================================================
# Core dependencies
# =========================================================
dependencies = [
"click>=8.1.7",
"PyYAML>=6.0.1",
"Jinja2>=3.1.2",
"pydantic>=2.0.0",
]
# =========================================================
# Optional dependencies for development
# =========================================================
[project.optional-dependencies]
dev = [
"ruff>=0.14.8",
"mypy>=1.10",
"types-PyYAML>=6.0",
]
test = [
"pytest>=7.4.4",
]
# =========================================================
# Ruff (Linting & Formatting)
# =========================================================
[tool.ruff]
line-length = 100
target-version = "py310"
[tool.ruff.lint]
select = ["E", "F", "I", "UP", "B"]
ignore = ["E501"] # line-length handled by formatter
[tool.ruff.lint.per-file-ignores]
"tests/**" = ["B", "E"]
# =========================================================
# Mypy (static typing and plugins)
# =========================================================
[tool.mypy]
plugins = ['pydantic.mypy']
python_version = "3.10"
ignore_missing_imports = true
warn_return_any = true
warn_unused_ignores = true
check_untyped_defs = true
[tool.pydantic-mypy]
init_forbid_extra = true
init_typed = true
warn_required_dynamic_aliases = true
# =========================================================
# Pytest
# =========================================================
[tool.pytest.ini_options]
addopts = [
"--import-mode=importlib",
"-v"
]
# =========================================================
# Project information
# =========================================================
# URLs for project
[project.urls]
Homepage = "https://github.com/docsible/docsible"
Repository = "https://github.com/docsible/docsible"
Issues = "https://github.com/docsible/docsible/issues"
Documentation = "https://github.com/docsible/docsible"
# =========================================================
# Project cli entrypoint
# =========================================================
# Entry points (scripts) - works with uv, pip
[project.scripts]
docsible = "docsible.cli:cli"
# =========================================================
# Build system (Hatch)
# =========================================================
# Build system configuration - supports multiple backends
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
# Hatch configuration for building
[tool.hatch.build.targets.wheel]
packages = ["docsible"]
[tool.hatch.build.targets.sdist]
include = [
"/docsible",
"/README.md",
"/LICENSE",
"/CONFIGURATION.md",
]
#########################################################################
# Poetry configuration (for backward compatibility) soon to be deprecated
#########################################################################
[tool.poetry]
name = "docsible"
version = "0.9.0"
description = "Document generator for ansible role/collection"
authors = ["Lucian BLETAN <neuraluc@gmail.com>"]
repository = "https://github.com/docsible/docsible"
license = "MIT"
readme = "README.md"
classifiers = [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: POSIX",
"Operating System :: MacOS",
"Operating System :: Unix",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Topic :: Software Development :: Libraries :: Python Modules"
]
[tool.poetry.dependencies]
python = ">=3.10"
click = "^8.1.7"
PyYAML = "^6.0.1"
Jinja2 = "^3.1.2"
pydantic = "^2.0.0"
[tool.poetry.scripts]
docsible = 'docsible.cli:cli'