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 = "m@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) version = "0.1.3"

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) 

44) [project.scripts]
45) derivepassphrase = "derivepassphrase.cli:derivepassphrase"
46) 

47) [project.urls]

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

49) Issues = "https://github.com/the-13th-letter/derivepassphrase/issues"
50) Source = "https://github.com/the-13th-letter/derivepassphrase"
51) 

52) [tool.coverage.html]
53) directory = "html/coverage"

54) 

55) [tool.coverage.paths]
56) src = ["src"]
57) tests = ["tests"]

58) 

59) [tool.coverage.report]
60) skip_covered = false
61) skip_empty = true
62) precision = 3
63) partial_branches = [
64)     'pragma: no branch',
65) ]
66) exclude_also = [
67)   "if __name__ == .__main__.:",
68)   'if (?:typing\.)?TYPE_CHECKING:',
69)   "raise AssertionError",
70)   "raise NotImplementedError",
71)   'assert False',
72) ]

73) 

74) [tool.coverage.run]
75) source_pkgs = ["derivepassphrase", "tests"]
76) branch = true
77) parallel = true
78) omit = [
79)   "__main__.py",
80) ]

81) 

82) [tool.hatch.build.targets.sdist]
83) exclude = [
84)     'towncrier.d/[0123456789+]*.md',
85) ]
86) 
87) [tool.hatch.build.targets.wheel]

88) packages = ['src/derivepassphrase']

89) 

90) [tool.hatch.env]
91) requires = [
92)   "hatch-mkdocs",
93) ]
94) 
95) [tool.hatch.env.collectors.mkdocs.docs]
96) path = "mkdocs.yml"
97) 

98) [tool.hatch.envs.docs]
99) extra-dependencies = [

100)   # Our documentation uses the Material theme.  It also uses
101)   # `mkdocstrings[python]`, but `hatch-mkdocs` is apparently smart
102)   # enough to pick *that* one up from the MkDocs configuration, but not
103)   # the selected theme...
104)   "mkdocs-material",
105)   # Our documentation uses formatted function signatures (i.e. with
106)   # formatted type annotations), which requires `black`.

107)   "black",

108)   # Our documentation is generated in multiple versions, orchestrated by
109)   # `mike`.

110)   "mike",

111) ]
112) detached = false
113) 

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

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

116) dependencies = [

117)   "ruff ~= 0.6.0",

118) ]

119) 
120) [tool.hatch.envs.hatch-test]
121) default-args = ['src', 'tests']
122) 
123) [[tool.hatch.envs.hatch-test.matrix]]
124) python = ["3.10", "3.11", "3.12", "pypy3.10"]
125) 
126) [tool.hatch.envs.release]

127) extra-dependencies = [
128)   "towncrier >= 23.11"
129) ]

130) 
131) [tool.hatch.envs.release.scripts]
132) 

133) [tool.hatch.envs.types]
134) extra-dependencies = [

135)   "mypy ~= 1.0",

136)   "pytest ~= 8.1",

137) ]

138) 

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

142) [tool.hatch.version]
143) path = "src/derivepassphrase/__init__.py"

144) 

145) [tool.mypy]
146) files = ['src/**/*.py', 'tests/**/*.py']
147) mypy_path = '$MYPY_CONFIG_FILE_DIR/src'
148) explicit_package_bases = true
149) implicit_reexport = false
150) sqlite_cache = true

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

152) 

153) [tool.pytest.ini_options]
154) addopts = '--doctest-modules'
155) pythonpath = ['src']
156) testpaths = ['src', 'tests']
157) xfail_strict = true

158) 
159) [tool.ruff]
160) line-length = 79
161) src = ["src"]
162) 
163) [tool.ruff.format]

164) docstring-code-format = true

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

166) preview = true

167) quote-style = 'single'

168) 
169) [tool.ruff.lint]

170) ignore = [
171)     # Suggested ignore by ruff when also using ruff to format.  We *do*
172)     # check for E501, because this usually only happens when there is a text
173)     # string that should be manually broken.
174)     'W191', 'E111', 'E114', 'E117', 'D206', 'D300', 'Q000', 'Q001', 'Q002',
175)     'Q003', 'COM812', 'COM819', 'ISC001', 'ISC002',

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

178)     'S101',

179)     # The formatter takes care of trailing commas and docstring code
180)     # automatically.
181)     'COM812', 'W505',
182)     # We document transitive exceptions as well (if we feel they would be
183)     # surprising to the user otherwise).
184)     'DOC502',
185)     # We currently don't have issues for every TODO.  Forcing an issue also
186)     # goes against the philosophy of TODOs as low-overhead markers for
187)     # future work; see
188)     # https://gist.github.com/dmnd/ed5d8ef8de2e4cfea174bd5dafcda382 .
189)     'TD003',
190)     # We somewhat regularly use loops where each iteration needs a separate
191)     # try-except block.
192)     'PERF203',
193)     # We catch type-ignore comments without specific code via the mypy
194)     # configuration, not via ruff.
195)     'PGH003',

196) ]

197) preview = true
198) # We select here in the order of presentation on the ruff documentation
199) # website.  ruff default selection (v0.6.2) is merely E4, E7, E9 and F.
200) select = [
201)     'F', 'E', 'W', 'C90', 'I', 'N', 'D', 'UP', 'YTT',
202)     'ANN', 'ASYNC', 'S', 'BLE', 'FBT', 'B', 'A', 'COM',
203)     'CPY', 'C4', 'DTZ', 'T10', 'DJ', 'EM', 'EXE', 'FA',
204)     'ISC', 'ICN', 'LOG', 'G', 'INP', 'PIE', 'T20', 'PYI',
205)     'PT', 'Q', 'RET', 'SLF', 'SLOT', 'SIM', 'TID', 'TCH',
206)     'INT', 'ARG',
207)     # We currently do not use pathlib. Disable 'PTH'.
208)     'TD',
209)     # We use TODOs and FIXMEs as notes for later, and don't want the linter
210)     # to nag about every occurrence.  Disable 'FIX'.
211)     #
212)     # The "eradicate" rule is prone to a lot of false positives, and it is
213)     # unclear to me, and probably confusing to read, where to apply a noqa
214)     # marker.  Instead, disable 'ERA', and if necessary, specify it on the
215)     # command-line.
216)     'PD', 'PGH', 'PL', 'TRY', 'FLY', 'NPY', 'FAST',
217)     'AIR', 'PERF', 'FURB', 'DOC', 'RUF',

218) ]

219) 

220) [tool.ruff.lint.per-file-ignores]
221) "**/scripts/*" = [
222)   # Suggested by hatch.
223)   'INP',
224)   # Suggested by hatch.
225)   'T20',
226) ]

227) "**/tests/**/*" = [

228)   # Suggested by hatch, assumingly because it may be important to verify
229)   # that the value is exactly the empty string, and not just any falsy
230)   # value.
231)   'PLC1901',
232)   # Suggested by hatch, assumingly because tests may use "magic values".
233)   'PLR2004',
234)   # Suggested by hatch, because tests are typically organized as classes and
235)   # instance methods but may not really be using the `self` argument.
236)   'PLR6301',
237)   # Suggested by hatch, because these warnings may be precisely what the
238)   # tests are supposed to test.
239)   'S',
240)   # Suggested by hatch, because pytest-style tests conventionally import
241)   # code from each other via relative imports.
242)   'TID252',
243)   # Our tests regularly use arguments named `input` to store an input
244)   # (text-/byte-)string.

245)   'A002',

246)   # We regularly annotate pytest fixtures like monkeypatch as `Any`.
247)   'ANN401',
248)   # Our tests generally don't contain docstrings.
249)   'D', 'DOC',

250)   # Our tests are regularly parametrized with booleans, for benign
251)   # purposes.

252)   'FBT',

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

256)   'PLC2701',

257)   # Too many public methods/arguments/returns/branches/locals doesn't really
258)   # apply here.
259)   'PLR0904', 'PLR0911', 'PLR0912', 'PLR0913', 'PLR0914', 'PLR0915',
260)   'PLR0916', 'PLR0917',

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

264)   'SLF001',

265) ]
266) 

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

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

272) fixture-parentheses = false
273) mark-parentheses = false

274) parametrize-names-type = 'list'

275) 

276) [tool.ruff.lint.flake8-tidy-imports]
277) ban-relative-imports = "all"
278) 
279) [tool.ruff.lint.isort]
280) known-first-party = ["derivepassphrase"]
281) 
282) [tool.ruff.lint.pycodestyle]
283) ignore-overlong-task-comments = true  # for E501
284) max-doc-length = 72  # for W505
285) 

286) [tool.ruff.lint.pydocstyle]
287) convention = 'google'