derivepassphrase.git

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/index.md

30) 
31) <!-- towncrier release notes start -->
32) 

33) ## 0.2.0 (2024-09-12)
34) 
35) #### Added
36) 
37) - Support configuration data export from `vault` in v0.2, v0.3 and storeroom
38)   formats.
39) 
40)     This feature requires the `cryptography` Python module, but is available
41)   even if `vault` is not installed. ([#1])
42) 
43) [#1]: https://github.com/the-13th-letter/derivepassphrase/1
44) 
45) #### Fixed
46) 
47) - Deploy versioned documentation with [mike](https://pypi.org/project/mike).
48)   Set up a "latest" tag and the "0.<var>x</var>" version of the documentation
49)   with the contents so far.
50) 
51) #### Changed
52) 
53) - Changed `sequin` and `ssh_agent_client` to be submodules of
54)   `derivepassphrase`.  Further moved `derivepassphrase.Vault` and
55)   `derivepassphrase.AmbiguousByteRepresentation` into a new submodule `vault`,
56)   and renamed submodule `ssh_agent_client` to `ssh_agent`. ([#3])
57) - Changed internal error handling and error messages, to better work in the
58)   context of a command-line tool. ([#4])
59) - Combine and consolidate `derivepassphrase.types` and
60)   `derivepassphrase.ssh_agent.types` into a new submodule
61)   `derivepassphrase._types`.  Despite the name, the module is public. ([#7])
62) - Warn the user when entering (directly, or via configuration
63)   editing/importing) a passphrase that is not in the configured Unicode
64)   normalization form. (But don't otherwise reject any textual master
65)   passphrases.) ([#9])
66) - Move all existing functionality into a subcommand, in anticipation of other
67)   passphrase derivation schemes, with different settings.  Automatically
68)   forward calls without a subcommand to the "vault" subcommand.
69) 
70)     Also store the settings in a file specific to the respective subsystem,
71)   instead of globally.  Automatically fall back to, and migrate, the old global
72)   settings file if no subsystem-specific configuration was found. ([#10])
73) 
74) - Make `derivepassphrase_export` a subcommand: `derivepassphrase export`.
75)   ([#11])
76) 
77) [#3]: https://github.com/the-13th-letter/derivepassphrase/3
78) [#4]: https://github.com/the-13th-letter/derivepassphrase/4
79) [#7]: https://github.com/the-13th-letter/derivepassphrase/7
80) [#9]: https://github.com/the-13th-letter/derivepassphrase/9
81) [#10]: https://github.com/the-13th-letter/derivepassphrase/10
82) [#11]: https://github.com/the-13th-letter/derivepassphrase/11
83) 
84) #### Deprecated
85) 
86) - Using the implied subcommand or the implied global configuration file is
87)   deprecated, and will be removed in v1.0.
88) 
89) 

90) ## 0.1.3 (2024-07-28)
91) 
92) #### Fixed
93) 
94) - Do not crash upon selecting a key on the command-line if there already is a
95)   key stored in the configuration. ([#5])
96) - Create the configuration directory upon saving, if it does not yet exist.
97)   ([#6])
98) - Isolate the tests properly and consistently from the user's configuration, so
99)   that user configuration problems do not cause unrelated test failures. ([#8])
100) - Add an alternate MkDocs configuration for building the documentation in
101)   offline mode.
102) - Fix typing issues according to `mypy`'s strict mode.
103) 
104) [#5]: https://github.com/the-13th-letter/derivepassphrase/5
105) [#6]: https://github.com/the-13th-letter/derivepassphrase/6
106) [#8]: https://github.com/the-13th-letter/derivepassphrase/8
107) 
108) 

109) ## 0.1.2 (2024-07-22)
110) 
111) #### Fixed
112) 
113) - Include and exclude the correct files in the `sdist` and `wheel`
114)   distributions.  (Previously, `sdist` contained VCS artifacts, and `wheel` was
115)   missing some paths.)

116) - Lint and reformat all code using [ruff](https://pypi.org/package/ruff/).
117) - Mention
118)   [`mkdocstrings-python`](https://pypi.org/package/mkdocstrings-python/) in

119)   the documentation's page footer.
120) - Remove JavaScript and external font loading from documentation website, so
121)   that the site works even in restricted browser settings.
122) - Set up a changelog, using [towncrier](https://pypi.org/package/towncrier).
123) 
124)