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.10"

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.10",

21)   "Programming Language :: Python :: 3.11",
22)   "Programming Language :: Python :: 3.12",
23)   "Programming Language :: Python :: Implementation :: CPython",
24)   "Programming Language :: Python :: Implementation :: PyPy",
25) ]
26) dependencies = [

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

33)   "typing_extensions",

34) ]

35) dynamic = ['version']

36) 
37) [project.optional-dependencies]

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

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

49) 

50) [project.scripts]
51) derivepassphrase = "derivepassphrase.cli:derivepassphrase"

52) derivepassphrase_export = "derivepassphrase.exporter:derivepassphrase_export"

53) 

54) [project.urls]

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

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

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

61) 

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

65) 

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

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

80) ]

81) 

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

89) 

90) [tool.hatch.build.targets.sdist]
91) exclude = [
92)     'towncrier.d/[0123456789+]*.md',
93) ]
94) 
95) [tool.hatch.build.targets.wheel]

96) packages = ['src/derivepassphrase']

97) 

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

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

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

115)   "black",

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

118)   "mike",

119) ]
120) detached = false
121) 

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

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

124) dependencies = [

125)   "ruff ~= 0.6.0",

126) ]

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

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

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

136) python = ["3.12", "3.11", "3.10", "pypy3.10"]
137) cryptography = ["no", "yes"]
138) hypothesis-profile = ["user-default"]

139) 

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

141) cryptography = ["yes"]
142) hypothesis-profile = ["ci"]

143) 
144) [tool.hatch.envs.hatch-test.overrides]

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

147) ]

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

157) 

158) [tool.hatch.envs.release]

159) extra-dependencies = [
160)   "towncrier >= 23.11"
161) ]

162) 
163) [tool.hatch.envs.release.scripts]
164) 

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

167)   "hypothesis >= 6.0",

168)   "mypy ~= 1.0",

169)   "pytest ~= 8.1",

170) ]

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

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

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

180) 

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

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

188) 

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

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

200) docstring-code-format = true

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

202) preview = true

203) quote-style = 'single'

204) 
205) [tool.ruff.lint]

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

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

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

214)     'S101',

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

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

220)     'DOC502',

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

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

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

228)     'PERF203',

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

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

235) ]

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

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

250)     #

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

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

257) ]

258) 

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

266) "**/tests/**/*" = [

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

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

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

285)   'A002',

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

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

292)   'FBT',

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

296)   'PLC2701',

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

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

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

304)   'SLF001',

305) ]
306) 

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

310) 

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

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

314) parametrize-names-type = 'list'

315) 

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

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