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 formatted function signatures (i.e. with
110)   # formatted type annotations), which requires `black`.

111)   "black",

112)   # Our changelog is assembled from singular entries, orchestrated by
113)   # `scriv`.
114)   "scriv >= 1.4"

115) ]
116) detached = false
117) 

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

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

120) dependencies = [

121)   "ruff ~= 0.6.0",

122) ]

123) 
124) [tool.hatch.envs.hatch-test]
125) default-args = ['src', 'tests']

126) extra-dependencies = [
127)     "hypothesis >= 6.0",
128) ]
129) matrix-name-format = '{variable}_{value}'

130) 
131) [[tool.hatch.envs.hatch-test.matrix]]

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

133) cryptography = ["no", "yes"]
134) hypothesis-profile = ["user-default"]

135) parser-version = ["PEG"]
136) 
137) [[tool.hatch.envs.hatch-test.matrix]]
138) python = ["3.9", "pypy3.9"]
139) cryptography = ["no", "yes"]
140) hypothesis-profile = ["user-default"]
141) parser-version = ["LL1"]

142) 

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

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

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

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

150) ]

151) matrix.hypothesis-profile.env-vars = [
152)     { key = "HYPOTHESIS_PROFILE", if = ["ci", "default", "dev", "debug"] },
153) ]

154) matrix.parser-version.env-vars = [
155)     { key = "PYTHONOLDPARSER", value = "1", if = ["LL1"] },
156) ]

157) 
158) [tool.hatch.envs.hatch-test.scripts]
159) run = "pytest --hypothesis-profile={env:HYPOTHESIS_PROFILE:default}{env:HATCH_TEST_ARGS:} {args}"
160) run-cov = "coverage run -m pytest --hypothesis-profile={env:HYPOTHESIS_PROFILE:default}{env:HATCH_TEST_ARGS:} {args}"
161) cov-combine = "coverage combine"
162) cov-report = "coverage report"

163) 

164) [tool.hatch.envs.types]
165) extra-dependencies = [

166)   "hypothesis >= 6.0",

167)   "mypy ~= 1.0",

168)   "pytest ~= 8.1",

169) ]

170) features = [
171)     "export",
172) ]
173) 

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

177) [tool.hatch.version]
178) path = "src/derivepassphrase/__init__.py"

179) 

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

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

187) 

188) [tool.pytest.ini_options]
189) addopts = '--doctest-modules'
190) pythonpath = ['src']
191) testpaths = ['src', 'tests']
192) xfail_strict = true

193) 
194) [tool.ruff]
195) line-length = 79
196) src = ["src"]
197) 
198) [tool.ruff.format]

199) docstring-code-format = true

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

201) preview = true

202) quote-style = 'single'

203) 
204) [tool.ruff.lint]

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

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

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

213)     'S101',

214)     # The formatter takes care of trailing commas and docstring code
215)     # automatically.
216)     'COM812', 'W505',

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

219)     'DOC502',

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

223)     # https://gist.github.com/dmnd/ed5d8ef8de2e4cfea174bd5dafcda382 .
224)     'TD003',

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

227)     'PERF203',

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

231)     # We catch type-ignore comments without specific code via the mypy
232)     # configuration, not via ruff.
233)     'PGH003',

234) ]

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

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

249)     #

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

254)     'PD', 'PGH', 'PL', 'TRY', 'FLY', 'NPY', 'FAST',
255)     'AIR', 'PERF', 'FURB', 'DOC', 'RUF',

256) ]

257) 

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

265) "**/tests/**/*" = [

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

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

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

284)   'A002',

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

289)   # Our tests are regularly parametrized with booleans, for benign
290)   # purposes.

291)   'FBT',

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

295)   'PLC2701',

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

298)   'PLR0904', 'PLR0911', 'PLR0912', 'PLR0913', 'PLR0914', 'PLR0915',
299)   'PLR0916', 'PLR0917',

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

303)   'SLF001',

304) ]
305) 

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

309) 

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

311) fixture-parentheses = false
312) mark-parentheses = false

313) parametrize-names-type = 'list'

314) 

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

325) [tool.ruff.lint.pydocstyle]
326) convention = 'google'

327)