df4e33299f059c55211861f029e2f58d8081e164
Marco Ricci Add a changelog and support...

Marco Ricci authored 3 months ago

1) # Changelog for `derivepassphrase`
2) 
3) [![Keeping a changelog][CHANGELOG_BADGE]][KEEP_A_CHANGELOG]
4) [![Using Semantic Versioning][SEMVER_BADGE]][SEMANTIC_VERSIONING]
5) 
6)   [CHANGELOG_BADGE]: Keep_a_changelog-E05735.svg
7)   [SEMVER_BADGE]: SemVer-3F4551.svg
8)   [KEEP_A_CHANGELOG]: https://keepachangelog.com/en/1.1.0/ 'Keeping a changelog'
9)   [SEMANTIC_VERSIONING]: https://semver.org/ 'Using Semantic Versioning'
10) 
11) <aside markdown><small>
12) (All entries are from the perspective of a user, not a developer.
13) The <q>public API</q>, as defined by Semantic Versioning, is outlined in the
14) [Reference section][REFERENCE]: the set of documented modules, classes,
15) methods and functions, and the documented behavior, options and arguments of
16) the command-line tools.
17) As per the Semantic Versioning and the Keep a Changelog terminology,
18) <q>Fixed</q> entries justify a <q>patch</q> release,
19) <q>Added</q> and <q>Deprecated</q> entries a <q>minor</q> release,
20) and <q>Changed</q> and <q>Removed</q> entries a <q>major</q> release.
21) <q>Security</q> can justify any type of release;
22) if <q>major</q> or <q>minor</q>, these are accompanied by corresponding
23) entries of the respective types above.
24) Again as per Semantic Versioning, at major version zero, the above
25) justification is not yet binding, and <em>any</em> new release may
26) effectively constitute a new <q>major</q> release.)
27) </small></aside>
28) 
29)   [REFERENCE]: reference.md
30) 
31) <!-- towncrier release notes start -->
32) 
Marco Ricci Release 0.1.3

Marco Ricci authored 3 months ago

33) ## 0.1.3 (2024-07-28)
34) 
35) #### Fixed
36) 
37) - Do not crash upon selecting a key on the command-line if there already is a
38)   key stored in the configuration. ([#5])
39) - Create the configuration directory upon saving, if it does not yet exist.
40)   ([#6])
41) - Isolate the tests properly and consistently from the user's configuration, so
42)   that user configuration problems do not cause unrelated test failures. ([#8])
43) - Add an alternate MkDocs configuration for building the documentation in
44)   offline mode.
45) - Fix typing issues according to `mypy`'s strict mode.
46) 
47) [#5]: https://github.com/the-13th-letter/derivepassphrase/5
48) [#6]: https://github.com/the-13th-letter/derivepassphrase/6
49) [#8]: https://github.com/the-13th-letter/derivepassphrase/8
50) 
51) 
Marco Ricci Release 0.1.2

Marco Ricci authored 3 months ago

52) ## 0.1.2 (2024-07-22)
53) 
54) #### Fixed
55) 
56) - Include and exclude the correct files in the `sdist` and `wheel`
57)   distributions.  (Previously, `sdist` contained VCS artifacts, and `wheel` was
58)   missing some paths.)
59) - Lint and reformat all code using [ruff](https://astral.sh/ruff/).
60) - Mention [`mkdocstrings-python`](https://mkdocstrings.github.io/python/) in
61)   the documentation's page footer.
62) - Remove JavaScript and external font loading from documentation website, so
63)   that the site works even in restricted browser settings.
64) - Set up a changelog, using [towncrier](https://pypi.org/package/towncrier).
65) 
66)