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) <!-- scriv changelog 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
38)     storeroom 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][].  Set up a "latest" tag and
48)     the "0.<var>x</var>" version of the documentation with the contents so
49)     far.
50) 
51) [mike]: https://pypi.org/project/mike
52) 
53) ### Changed
54) 
55)   - Changed `sequin` and `ssh_agent_client` to be submodules of
56)     `derivepassphrase`.  Further moved `derivepassphrase.Vault` and
57)     `derivepassphrase.AmbiguousByteRepresentation` into a new submodule
58)     `vault`, and renamed submodule `ssh_agent_client` to `ssh_agent`. ([#3])
59)   - Changed internal error handling and error messages, to better work in
60)     the context of a command-line tool. ([#4])
61)   - Combine and consolidate `derivepassphrase.types` and
62)     `derivepassphrase.ssh_agent.types` into a new submodule
63)     `derivepassphrase._types`.  Despite the name, the module is public.
64)     ([#7])
65)   - Warn the user when entering (directly, or via configuration
66)     editing/importing) a passphrase that is not in the configured Unicode
67)     normalization form. (But don't otherwise reject any textual master
68)     passphrases.) ([#9])
69)   - Move all existing functionality into a subcommand, in anticipation of
70)     other passphrase derivation schemes, with different settings.
71)     Automatically forward calls without a subcommand to the "vault"
72)     subcommand.

73) 
74)     Also store the settings in a file specific to the respective subsystem,

75)     instead of globally.  Automatically fall back to, and migrate, the old
76)     global settings file if no subsystem-specific configuration was found.
77)     ([#10])

78) 

79)   - Make `derivepassphrase_export` a subcommand: `derivepassphrase export`.
80)     ([#11])

81) 
82) [#3]: https://github.com/the-13th-letter/derivepassphrase/3
83) [#4]: https://github.com/the-13th-letter/derivepassphrase/4
84) [#7]: https://github.com/the-13th-letter/derivepassphrase/7
85) [#9]: https://github.com/the-13th-letter/derivepassphrase/9
86) [#10]: https://github.com/the-13th-letter/derivepassphrase/10
87) [#11]: https://github.com/the-13th-letter/derivepassphrase/11
88) 

89) ### Deprecated

90) 

91)   - Using the implied subcommand or the implied global configuration file is
92)     deprecated, and will be removed in v1.0.

93) 
94) 

95) ## 0.1.3 (2024-07-28)
96) 

97) ### Fixed

98) 

99)   - Do not crash upon selecting a key on the command-line if there already
100)     is a key stored in the configuration. ([#5])
101)   - Create the configuration directory upon saving, if it does not yet
102)     exist.  ([#6])
103)   - Isolate the tests properly and consistently from the user's
104)     configuration, so that user configuration problems do not cause
105)     unrelated test failures. ([#8])
106)   - Add an alternate MkDocs configuration for building the documentation in
107)     offline mode.
108)   - Fix typing issues according to `mypy`'s strict mode.

109) 
110) [#5]: https://github.com/the-13th-letter/derivepassphrase/5
111) [#6]: https://github.com/the-13th-letter/derivepassphrase/6
112) [#8]: https://github.com/the-13th-letter/derivepassphrase/8
113) 
114) 

115) ## 0.1.2 (2024-07-22)
116) 

117) ### Fixed

118) 

119)   - Include and exclude the correct files in the `sdist` and `wheel`
120)     distributions.  (Previously, `sdist` contained VCS artifacts, and
121)     `wheel` was missing some paths.)

122)   - Lint and reformat all code using [ruff](https://pypi.org/package/ruff/).
123)   - Mention
124)     [`mkdocstrings-python`](https://pypi.org/package/mkdocstrings-python/)

125)     in the documentation's page footer.
126)   - Remove JavaScript and external font loading from documentation website,
127)     so that the site works even in restricted browser settings.
128)   - Set up a changelog, using
129)     [towncrier](https://pypi.org/package/towncrier).

130) 
131) 

132) ## 0.1.1 (2024-07-14)
133) 

134) ### Fixed

135) 

136)   - Restore the `__version__` attribute in all top-level packages.
137)   - Declare compatibility with Python 3.10 in project metadata, and include
138)     necessary version-specific dependencies.
139)   - Publish the documentation online, and link to it in the repository
140)     metadata and the Python package metadata.

141) 
142) 
143) ## 0.1.0 (2024-07-14)
144) 

145) ### Added

146)