derivepassphrase.git

1) [build-system]
2) requires = ["hatchling"]
3) build-backend = "hatchling.build"
4) 
5) [project]
6) name = "derivepassphrase"
7) description = "An almost faithful Python reimplementation of James Coglan's vault."
8) readme = "README.md"

9) requires-python = ">= 3.9"

10) license = "MIT"
11) keywords = []
12) authors = [

13)   { name = "Marco Ricci", email = "software@the13thletter.info" },

14) ]
15) classifiers = [
16)   "Development Status :: 4 - Beta",
17)   "Environment :: Console",

18)   "License :: OSI Approved :: MIT License",

19)   "Programming Language :: Python :: 3",

20)   "Programming Language :: Python :: 3.9",

21)   "Programming Language :: Python :: 3.10",

22)   "Programming Language :: Python :: 3.11",
23)   "Programming Language :: Python :: 3.12",

24)   "Programming Language :: Python :: 3.13",

25)   "Programming Language :: Python :: Implementation :: CPython",
26)   "Programming Language :: Python :: Implementation :: PyPy",
27) ]
28) dependencies = [

29)   # We use click for the command-line interface.  We require version 8.1.0
30)   # or higher due to click issue #1985.
31)   "click >= 8.1",
32)   # We include type annotations, and use facilities that are not readily
33)   # available in older Pythons (such as typing.Self).  These are loaded from
34)   # typing_extensions, instead of using explicit version guards.

35)   "typing_extensions",

36) ]

37) dynamic = ['version']

38) 
39) [project.optional-dependencies]

40) dev = [
41)   # Development uses the hatch build system, to isolate all tools in their
42)   # own virtual environment.
43)   "hatch ~= 1.10",
44) ]

45) export = [
46)   # The vault configuration exporter relies on cryptography.  Version 38 was
47)   # the first to include the `algorithms.AES256` interface, instead of only
48)   # the `algorithms.AES` interface.
49)   "cryptography >= 38.0.0",
50) ]

51) 

52) [project.scripts]
53) derivepassphrase = "derivepassphrase.cli:derivepassphrase"
54) 

55) [project.urls]

56) Documentation = "https://the13thletter.info/derivepassphrase/"

57) Issues = "https://github.com/the-13th-letter/derivepassphrase/issues"
58) Source = "https://github.com/the-13th-letter/derivepassphrase"
59) 

60) [tool.coverage.html]
61) directory = "html/coverage"

62) 

63) [tool.coverage.paths]
64) src = ["src"]
65) tests = ["tests"]

66) 

67) [tool.coverage.report]
68) skip_covered = false
69) skip_empty = true
70) precision = 3
71) partial_branches = [
72)     'pragma: no branch',
73) ]
74) exclude_also = [
75)   "if __name__ == .__main__.:",
76)   'if (?:typing\.)?TYPE_CHECKING:',
77)   "raise AssertionError",
78)   "raise NotImplementedError",
79)   'assert False',

80)   '(?:typing\.)?assert_never\(',

81) ]

82) 

83) [tool.coverage.run]
84) source_pkgs = ["derivepassphrase", "tests"]
85) branch = true
86) parallel = true
87) omit = [
88)   "__main__.py",
89) ]

90) 

91) [tool.hatch.build.targets.sdist]
92) exclude = [

93)     'docs/changelog.d/*.md',

94) ]
95) 
96) [tool.hatch.build.targets.wheel]

97) packages = ['src/derivepassphrase']

98) 

99) [tool.hatch.env]
100) requires = [
101)   "hatch-mkdocs",
102) ]
103) 
104) [tool.hatch.env.collectors.mkdocs.docs]
105) path = "mkdocs.yml"
106) 

107) [tool.hatch.envs.docs]
108) extra-dependencies = [

109)   # Our documentation uses the Material theme.  It also uses
110)   # `mkdocstrings[python]`, but `hatch-mkdocs` is apparently smart
111)   # enough to pick *that* one up from the MkDocs configuration, but not
112)   # the selected theme...
113)   "mkdocs-material",
114)   # Our documentation uses formatted function signatures (i.e. with
115)   # formatted type annotations), which requires `black`.

116)   "black",

117)   # Our documentation is generated in multiple versions, orchestrated by
118)   # `mike`.

119)   "mike",

120) ]
121) detached = false
122) 

123) [tool.hatch.envs.hatch-static-analysis]

124) config-path = "/dev/null"

125) dependencies = [

126)   "ruff ~= 0.6.0",

127) ]

128) 
129) [tool.hatch.envs.hatch-test]
130) default-args = ['src', 'tests']

131) extra-dependencies = [
132)     "hypothesis >= 6.0",
133) ]
134) matrix-name-format = '{variable}_{value}'

135) 
136) [[tool.hatch.envs.hatch-test.matrix]]

137) python = ["3.13", "3.12", "3.11", "3.10", "3.9", "pypy3.10", "pypy3.9"]

138) cryptography = ["no", "yes"]
139) hypothesis-profile = ["user-default"]

140) parser-version = ["PEG"]
141) 
142) [[tool.hatch.envs.hatch-test.matrix]]
143) python = ["3.9", "pypy3.9"]
144) cryptography = ["no", "yes"]
145) hypothesis-profile = ["user-default"]
146) parser-version = ["LL1"]

147) 

148) [[tool.hatch.envs.hatch-test.matrix]]

149) cryptography = ["yes"]
150) hypothesis-profile = ["ci"]

151) 
152) [tool.hatch.envs.hatch-test.overrides]

153) matrix.cryptography.features = [
154)     { value = "export", if = ["yes"] },

155) ]

156) matrix.hypothesis-profile.env-vars = [
157)     { key = "HYPOTHESIS_PROFILE", if = ["ci", "default", "dev", "debug"] },
158) ]

159) matrix.parser-version.env-vars = [
160)     { key = "PYTHONOLDPARSER", value = "1", if = ["LL1"] },
161) ]

162) 
163) [tool.hatch.envs.hatch-test.scripts]
164) run = "pytest --hypothesis-profile={env:HYPOTHESIS_PROFILE:default}{env:HATCH_TEST_ARGS:} {args}"
165) run-cov = "coverage run -m pytest --hypothesis-profile={env:HYPOTHESIS_PROFILE:default}{env:HATCH_TEST_ARGS:} {args}"
166) cov-combine = "coverage combine"
167) cov-report = "coverage report"

168) 

169) [tool.hatch.envs.release]

170) extra-dependencies = [

171)   "scriv >= 1.4"

172) ]

173) 
174) [tool.hatch.envs.release.scripts]
175) 

176) [tool.hatch.envs.types]
177) extra-dependencies = [

178)   "hypothesis >= 6.0",

179)   "mypy ~= 1.0",

180)   "pytest ~= 8.1",

181) ]

182) features = [
183)     "export",
184) ]
185) 

186) [tool.hatch.envs.types.scripts]
187) check = "mypy --install-types --non-interactive {args:src/derivepassphrase tests}"
188) 

189) [tool.hatch.version]
190) path = "src/derivepassphrase/__init__.py"

191) 

192) [tool.mypy]
193) files = ['src/**/*.py', 'tests/**/*.py']
194) mypy_path = '$MYPY_CONFIG_FILE_DIR/src'
195) explicit_package_bases = true
196) implicit_reexport = false
197) sqlite_cache = true

198) enable_error_code = ['ignore-without-code']

199) 

200) [tool.pytest.ini_options]
201) addopts = '--doctest-modules'
202) pythonpath = ['src']
203) testpaths = ['src', 'tests']
204) xfail_strict = true

205) 
206) [tool.ruff]
207) line-length = 79
208) src = ["src"]
209) 
210) [tool.ruff.format]

211) docstring-code-format = true

212) docstring-code-line-length = "dynamic"

213) preview = true

214) quote-style = 'single'

215) 
216) [tool.ruff.lint]

217) ignore = [
218)     # Suggested ignore by ruff when also using ruff to format.  We *do*

219)     # check for E501, because this usually only happens when there is
220)     # a text string that should be manually broken.
221)     'W191', 'E111', 'E114', 'E117', 'D206', 'D300', 'Q000', 'Q001',
222)     'Q002', 'Q003', 'COM812', 'COM819', 'ISC001', 'ISC002',

223)     # We use `assert` regularly to appease the type checker, and because
224)     # it is the right language tool for this job.

225)     'S101',

226)     # The formatter takes care of trailing commas and docstring code
227)     # automatically.
228)     'COM812', 'W505',

229)     # We document transitive exceptions as well (if we feel they would
230)     # be surprising to the user otherwise).

231)     'DOC502',

232)     # We currently don't have issues for every TODO.  Forcing an issue
233)     # also goes against the philosophy of TODOs as low-overhead markers
234)     # for future work; see

235)     # https://gist.github.com/dmnd/ed5d8ef8de2e4cfea174bd5dafcda382 .
236)     'TD003',

237)     # We somewhat regularly use loops where each iteration needs
238)     # a separate try-except block.

239)     'PERF203',

240)     # We do not currently use pathlib.  The PTH rules are unselected,
241)     # but FURB includes several pathlib-related rules.
242)     'FURB101', 'FURB103',

243)     # We catch type-ignore comments without specific code via the mypy
244)     # configuration, not via ruff.
245)     'PGH003',

246) ]

247) preview = true
248) # We select here in the order of presentation on the ruff documentation
249) # website.  ruff default selection (v0.6.2) is merely E4, E7, E9 and F.
250) select = [
251)     'F', 'E', 'W', 'C90', 'I', 'N', 'D', 'UP', 'YTT',
252)     'ANN', 'ASYNC', 'S', 'BLE', 'FBT', 'B', 'A', 'COM',
253)     'CPY', 'C4', 'DTZ', 'T10', 'DJ', 'EM', 'EXE', 'FA',
254)     'ISC', 'ICN', 'LOG', 'G', 'INP', 'PIE', 'T20', 'PYI',
255)     'PT', 'Q', 'RET', 'SLF', 'SLOT', 'SIM', 'TID', 'TCH',
256)     'INT', 'ARG',
257)     # We currently do not use pathlib. Disable 'PTH'.
258)     'TD',

259)     # We use TODOs and FIXMEs as notes for later, and don't want the
260)     # linter to nag about every occurrence.  Disable 'FIX'.

261)     #

262)     # The "eradicate" rule is prone to a lot of false positives, and it
263)     # is unclear to me, and probably confusing to read, where to apply
264)     # a noqa marker.  Instead, disable 'ERA', and if necessary, specify
265)     # it on the command-line.

266)     'PD', 'PGH', 'PL', 'TRY', 'FLY', 'NPY', 'FAST',
267)     'AIR', 'PERF', 'FURB', 'DOC', 'RUF',

268) ]

269) 

270) [tool.ruff.lint.per-file-ignores]
271) "**/scripts/*" = [
272)   # Suggested by hatch.
273)   'INP',
274)   # Suggested by hatch.
275)   'T20',
276) ]

277) "**/tests/**/*" = [

278)   # Suggested by hatch, assumingly because it may be important to verify
279)   # that the value is exactly the empty string, and not just any falsy
280)   # value.
281)   'PLC1901',
282)   # Suggested by hatch, assumingly because tests may use "magic values".
283)   'PLR2004',

284)   # Suggested by hatch, because tests are typically organized as classes
285)   # and instance methods but may not really be using the `self`
286)   # argument.

287)   'PLR6301',
288)   # Suggested by hatch, because these warnings may be precisely what the
289)   # tests are supposed to test.
290)   'S',
291)   # Suggested by hatch, because pytest-style tests conventionally import
292)   # code from each other via relative imports.
293)   'TID252',
294)   # Our tests regularly use arguments named `input` to store an input
295)   # (text-/byte-)string.

296)   'A002',

297)   # We regularly annotate pytest fixtures like monkeypatch as `Any`.
298)   'ANN401',
299)   # Our tests generally don't contain docstrings.
300)   'D', 'DOC',

301)   # Our tests are regularly parametrized with booleans, for benign
302)   # purposes.

303)   'FBT',

304)   # One of our standard modules is called `derivepassphrase._types`.
305)   # Importing this from the tests directory would then automatically
306)   # trigger `PLC2701`.

307)   'PLC2701',

308)   # Too many public methods/arguments/returns/branches/locals doesn't
309)   # really apply here.

310)   'PLR0904', 'PLR0911', 'PLR0912', 'PLR0913', 'PLR0914', 'PLR0915',
311)   'PLR0916', 'PLR0917',

312)   # To fully test the `derivepassphrase.cli` module (and a couple other
313)   # things), we need to call and to mock several internal functions,
314)   # which would automatically trigger `SLF001`.

315)   'SLF001',

316) ]
317) 

318) [tool.ruff.lint.flake8-copyright]
319) # Include hatch-enforced SPDX-FileCopyrightText in check.
320) notice-rgx = '(?i)(?:Copyright\s+((?:\(C\)|©)\s+)?|SPDX-FileCopyrightText:\s+)\d{4}((-|,\s)\d{4})*'

321) 

322) [tool.ruff.lint.flake8-pytest-style]

323) fixture-parentheses = false
324) mark-parentheses = false

325) parametrize-names-type = 'list'

326) 

327) [tool.ruff.lint.flake8-tidy-imports]
328) ban-relative-imports = "all"
329) 
330) [tool.ruff.lint.isort]
331) known-first-party = ["derivepassphrase"]
332) 
333) [tool.ruff.lint.pycodestyle]
334) ignore-overlong-task-comments = true  # for E501
335) max-doc-length = 72  # for W505
336) 

337) [tool.ruff.lint.pydocstyle]
338) convention = 'google'

339)