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) derivepassphrase_export = "derivepassphrase.exporter:derivepassphrase_export"

55) 

56) [project.urls]

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

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

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

63) 

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

67) 

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

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

82) ]

83) 

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

91) 

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

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

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

98) packages = ['src/derivepassphrase']

99) 

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

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

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

117)   "black",

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

120)   "mike",

121) ]
122) detached = false
123) 

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

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

126) dependencies = [

127)   "ruff ~= 0.6.0",

128) ]

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

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

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

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

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

141) 

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

143) cryptography = ["yes"]
144) hypothesis-profile = ["ci"]

145) 
146) [tool.hatch.envs.hatch-test.overrides]

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

149) ]

150) matrix.hypothesis-profile.env-vars = [
151)     { key = "HYPOTHESIS_PROFILE", if = ["ci", "default", "dev", "debug"] },
152) ]
153) 
154) [tool.hatch.envs.hatch-test.scripts]
155) run = "pytest --hypothesis-profile={env:HYPOTHESIS_PROFILE:default}{env:HATCH_TEST_ARGS:} {args}"
156) run-cov = "coverage run -m pytest --hypothesis-profile={env:HYPOTHESIS_PROFILE:default}{env:HATCH_TEST_ARGS:} {args}"
157) cov-combine = "coverage combine"
158) cov-report = "coverage report"

159) 

160) [tool.hatch.envs.release]

161) extra-dependencies = [

162)   "scriv >= 1.4"

163) ]

164) 
165) [tool.hatch.envs.release.scripts]
166) 

167) [tool.hatch.envs.types]
168) extra-dependencies = [

169)   "hypothesis >= 6.0",

170)   "mypy ~= 1.0",

171)   "pytest ~= 8.1",

172) ]

173) features = [
174)     "export",
175) ]
176) 

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

180) [tool.hatch.version]
181) path = "src/derivepassphrase/__init__.py"

182) 

183) [tool.mypy]
184) files = ['src/**/*.py', 'tests/**/*.py']
185) mypy_path = '$MYPY_CONFIG_FILE_DIR/src'
186) explicit_package_bases = true
187) implicit_reexport = false
188) sqlite_cache = true

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

190) 

191) [tool.pytest.ini_options]
192) addopts = '--doctest-modules'
193) pythonpath = ['src']
194) testpaths = ['src', 'tests']
195) xfail_strict = true

196) 
197) [tool.ruff]
198) line-length = 79
199) src = ["src"]
200) 
201) [tool.ruff.format]

202) docstring-code-format = true

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

204) preview = true

205) quote-style = 'single'

206) 
207) [tool.ruff.lint]

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

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

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

216)     'S101',

217)     # The formatter takes care of trailing commas and docstring code
218)     # automatically.
219)     'COM812', 'W505',

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

222)     'DOC502',

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

226)     # https://gist.github.com/dmnd/ed5d8ef8de2e4cfea174bd5dafcda382 .
227)     'TD003',

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

230)     'PERF203',

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

234)     # We catch type-ignore comments without specific code via the mypy
235)     # configuration, not via ruff.
236)     'PGH003',

237) ]

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

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

252)     #

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

257)     'PD', 'PGH', 'PL', 'TRY', 'FLY', 'NPY', 'FAST',
258)     'AIR', 'PERF', 'FURB', 'DOC', 'RUF',

259) ]

260) 

261) [tool.ruff.lint.per-file-ignores]
262) "**/scripts/*" = [
263)   # Suggested by hatch.
264)   'INP',
265)   # Suggested by hatch.
266)   'T20',
267) ]

268) "**/tests/**/*" = [

269)   # Suggested by hatch, assumingly because it may be important to verify
270)   # that the value is exactly the empty string, and not just any falsy
271)   # value.
272)   'PLC1901',
273)   # Suggested by hatch, assumingly because tests may use "magic values".
274)   'PLR2004',

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

278)   'PLR6301',
279)   # Suggested by hatch, because these warnings may be precisely what the
280)   # tests are supposed to test.
281)   'S',
282)   # Suggested by hatch, because pytest-style tests conventionally import
283)   # code from each other via relative imports.
284)   'TID252',
285)   # Our tests regularly use arguments named `input` to store an input
286)   # (text-/byte-)string.

287)   'A002',

288)   # We regularly annotate pytest fixtures like monkeypatch as `Any`.
289)   'ANN401',
290)   # Our tests generally don't contain docstrings.
291)   'D', 'DOC',

292)   # Our tests are regularly parametrized with booleans, for benign
293)   # purposes.

294)   'FBT',

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

298)   'PLC2701',

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

301)   'PLR0904', 'PLR0911', 'PLR0912', 'PLR0913', 'PLR0914', 'PLR0915',
302)   'PLR0916', 'PLR0917',

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

306)   'SLF001',

307) ]
308) 

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

312) 

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

314) fixture-parentheses = false
315) mark-parentheses = false

316) parametrize-names-type = 'list'

317) 

318) [tool.ruff.lint.flake8-tidy-imports]
319) ban-relative-imports = "all"
320) 
321) [tool.ruff.lint.isort]
322) known-first-party = ["derivepassphrase"]
323) 
324) [tool.ruff.lint.pycodestyle]
325) ignore-overlong-task-comments = true  # for E501
326) max-doc-length = 72  # for W505
327) 

328) [tool.ruff.lint.pydocstyle]
329) convention = 'google'

330)