poxy/pyproject.toml at main · marzer/poxy · 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
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
# This file is a part of marzer/poxy and is subject to the the terms of the MIT license.
# Copyright (c) Mark Gillard <mark.gillard@outlook.com.au>
# See https://github.com/marzer/poxy/master/LICENSE.txt for the full license text.
# SPDX-License-Identifier: MIT

# releasing: push a 'v*' git tag - .github/workflows/release.yaml builds and publishes to PyPI
# via trusted publishing. (manual fallback: python -m build && twine upload dist/*)

[build-system]
requires = ['setuptools', 'wheel']
build-backend = 'setuptools.build_meta'

[project]
name = 'poxy'
requires-python = '>=3.9'
description = 'Documentation generator for C++.'
authors = [{ name = "Mark Gillard", email = "mark.gillard@outlook.com.au" }]
license = { text = 'MIT' }
keywords = ['c++', 'doxygen', 'documentation']
classifiers = [
    'Development Status :: 4 - Beta',
    'License :: OSI Approved :: MIT License',
    'Programming Language :: C++',
    'Programming Language :: Python :: 3 :: Only',
    'Programming Language :: Python :: 3.9',
    'Programming Language :: Python :: 3.10',
    'Programming Language :: Python :: 3.11',
    'Programming Language :: Python :: 3.12',
    'Programming Language :: Python :: 3.13',
    'Topic :: Documentation',
    'Topic :: Software Development :: Code Generators',
    'Topic :: Software Development :: Documentation',
    'Topic :: Utilities',
]
dependencies = [
    'misk >= 0.8.1',
    'bs4',
    'jinja2',
    'pygments',
    'html5lib',
    'lxml',
    'tomli; python_version < "3.11"', # 3.11+ uses the stdlib tomllib
    'schema != 0.7.5',
    'requests',
    'trieregex',
    'colorama',
]
dynamic = ['version', 'readme']

[project.optional-dependencies]
test = ['pytest']
dev = [
    'pytest',
    'ruff == 0.15.14',
    'pyright == 1.1.409',
    'beautifulsoup4 == 4.13.3',
    'lxml-stubs == 0.5.1',
]

[project.scripts]
poxy = 'poxy:main'
poxyblog = 'poxy:main_blog_post'

[project.urls]
Source = 'https://github.com/marzer/poxy'
Tracker = 'https://github.com/marzer/poxy/issues'
Funding = 'https://github.com/sponsors/marzer'

[tool.setuptools]
zip-safe = true

[tool.setuptools.dynamic]
version = { file = 'VERSION' }
readme = { file = [
    'README.md',
    'CHANGELOG.md',
], content-type = 'text/markdown' }

[tool.setuptools.packages.find]
where = ["src"]
include = ["poxy*"]

[tool.setuptools.package-data]
"*" = [
    '*.css',
    '*.woff',
    '*.woff2',
    '*.json',
    '*.rst',
    '*.html',
    '*.xml',
    '*.png',
    '*.js',
    '*.svg',
    '*.txt',
]

[tool.setuptools.exclude-package-data]
"*" = ['meson.build', '.git*', '.istanbul.yaml', '*.pyc']

[tool.ruff]
line-length = 120
target-version = 'py39'
# the vendored m.css fork is maintained upstream - never lint or reformat it
extend-exclude = ['src/poxy/mcss']

[tool.ruff.format]
quote-style = 'preserve'         # matches the old black skip-string-normalization
skip-magic-trailing-comma = true

[tool.ruff.lint]
select = ['F', 'E4', 'E7', 'E9', 'W', 'I', 'UP', 'B']
ignore = [
    'F403', # 'from x import *' used (intentional throughout: misk, .utils, .version)
    'F405', # name may be undefined / from star imports (ditto)
    'F541', # f-string without placeholders (deliberate rf'' style habit)
    'E731', # assigning a lambda (used deliberately for small local callables)
    'E741', # ambiguous variable name (e.g. single-letter 'l')
    'B007', # unused loop control variable (noisy, low value)
    'B023', # closure over loop var: false positives here (lambdas invoked synchronously by re.sub / visitors)
]

[tool.ruff.lint.isort]
split-on-trailing-comma = false

[tool.pytest.ini_options]
testpaths = ['tests']
# unit tests need neither doxygen nor network; snapshot tests are marked and skip when doxygen is absent
addopts = '-ra'

[tool.pyright]
include = ['src/poxy', 'src/__main__.py', 'tests']
exclude = ['src/poxy/mcss', '**/__pycache__', '**/.*', 'build', 'dist']
pythonVersion = '3.9'
typeCheckingMode = 'basic'
reportMissingModuleSource = false
reportMissingTypeStubs = false
reportWildcardImportFromLibrary = false