tap-readthedocs/pyproject.toml at main · reservoir-data/tap-readthedocs · 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
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
166
167
168
169
[build-system]
build-backend = "hatchling.build"
requires = [
  "hatch-vcs==0.5",
  "hatchling==1.29",
]

[project]
name = "tap-readthedocs"
description = "Singer tap for ReadTheDocs, built with the Meltano SDK for Singer Taps."
readme = "README.md"
keywords = [
  "ELT",
  "ReadTheDocs",
  "singer.io",
]
license = "Apache-2.0"
license-files = [ "LICENSE" ]
maintainers = [
  { name = "Edgar Ramírez-Mondragón", email = "edgarrm358@gmail.com" },
]
authors = [
  { name = "Edgar Ramírez-Mondragón", email = "edgarrm358@gmail.com" },
]
requires-python = ">=3.12"
classifiers = [
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
]
dynamic = [
  "version",
]
dependencies = [
  "requests-cache~=1.0",
  "singer-sdk~=0.54.0a4",
  "toolz~=1.1.0",
]
urls.Documentation = "https://github.com/reservoir-data/tap-readthedocs#readme"
urls.Homepage = "https://github.com/reservoir-data/tap-readthedocs"
urls.Repository = "https://github.com/reservoir-data/tap-readthedocs"
scripts."tap-readthedocs" = "tap_readthedocs.tap:TapReadTheDocs.cli"

[dependency-groups]
dev = [
  { include-group = "testing" },
  { include-group = "typing" },
]
testing = [
  "deptry>=0.12",
  "pytest>=8",
  "singer-sdk[testing]",
]
typing = [
  "mypy",
  "ty>=0.0.8",
  "types-requests",
]

[tool.hatch]
version.source = "vcs"

[tool.uv]
required-version = ">=0.5.19"
prerelease = "allow"
preview = true

[tool.ruff]
line-length = 88
lint.select = [
  "ALL",
]
lint.ignore = [
  "COM812", # missing-trailing-comma
  "DJ",     # flake8-django
  "FIX002", # line-contains-todo
  "ISC001", # single-line-implicit-string-concatenation
]
lint.per-file-ignores."noxfile.py" = [
  "ANN",
]
lint.per-file-ignores."tests/*" = [
  "ANN201", # missing-return-type-public-function
  "S101",   # assert
  "SLF001", # private-member-access
]
lint.unfixable = [
  "ERA001", # commented-out-code
]
lint.flake8-annotations.allow-star-arg-any = true
lint.isort.known-first-party = [
  "tap_readthedocs",
]
lint.isort.required-imports = [
  "from __future__ import annotations",
]
lint.pydocstyle.convention = "google"

[tool.deptry]
package_module_name_map.mypy = "mypy"
package_module_name_map.types-requests = "requests"

[tool.pyproject-fmt]
max_supported_python = "3.14"

[tool.pytest]
addopts = [
  "-vvv",
  "-ra",
  "--strict-config",
  "--strict-markers",
]
filterwarnings = [
  "error",
  "default:Fields in transformed catalog but not in records:UserWarning",
  "default:No records returned in stream 'projects:UserWarning",
  "default:No records returned in stream 'redirects:UserWarning",
  "default:No records returned in stream 'subprojects:UserWarning",
  "default:No records returned in stream 'translations:UserWarning",
  "default:No records returned in stream 'versions:UserWarning",
  "default:No records were available to test:UserWarning",
  # Deprecation message introduced in Python 3.14. Upstream issue: https://github.com/python-attrs/cattrs/issues/635
  "default:'_UnionGenericAlias' is deprecated and slated for removal in Python 3.17:DeprecationWarning",
]
log_level = "INFO"
minversion = "9"
testpaths = [ "tests" ]
xfail_strict = true

[tool.tox]
min_version = "4.22"
requires = [ "tox", "tox-uv" ]
env_list = [
  "dependencies",
  "typing",
  "3.14",
  "3.13",
  "3.12",
]
env.dependencies.dependency_groups = [ "testing" ]
env.dependencies.commands = [ [ "deptry", "." ] ]
env.sync.commands = [ [ "tap-readthedocs", { replace = "posargs", default = [ "--config=ENV" ], extend = true } ] ]
env.typing.dependency_groups = [ "testing", "typing" ]
env.typing.commands = [
  [ "mypy", "--strict", { replace = "posargs", default = [ "tap_readthedocs", "tests" ], extend = true } ],
  [ "ty", "check", { replace = "posargs", default = [ "tap_readthedocs", "tests" ], extend = true } ],
]
env_run_base.runner = "uv-venv-lock-runner"
env_run_base.pass_env = [ "TAP_READTHEDOCS_*" ]
env_run_base.dependency_groups = [ "testing" ]
env_run_base.commands = [ [ "pytest", { replace = "posargs", default = [ "tests" ], extend = true } ] ]

[tool.mypy]
enable_error_code = [
  "ignore-without-code",
  "redundant-expr",
  "truthy-bool",
]
strict = true
warn_redundant_casts = true
warn_unreachable = true
warn_unused_configs = true
warn_unused_ignores = true
overrides = [
  { module = [
    "toolz.*", # https://github.com/pytoolz/toolz/issues/496
  ], ignore_missing_imports = true },
]