Update the README for v0.6 (863e371) - derivepassphrase.git

Update the README for v0.6

Marco Ricci commited on 2026-03-22 22:23:38
Zeige 3 geänderte Dateien mit 11 Einfügungen und 6 Löschungen.

Adjust the passages concerning SSH agent support and software
dependencies to accurately reflect the state in (what will later become)
v0.6.

Also fix typos in the page footer and in a previous changelog entry that
we came across while editing the README.

README.md bd8360a..90cf76d
docs/changelog.d/20251130_102427_the-13th-letter_ssh_agent_socket_providers.md b96b675..e8b2a7b
mkdocs.yml 1433e9c..ef137a6

README.md

Zeige Datei @ 863e371

@@ -12,7 +12,10 @@ The derivation is also *deterministic*, given the same inputs, thus the resultin
 
 The service name and constraints themselves also need not be kept secret; the latter are usually stored in a world-readable file to ease repeated entry of passphrase constraints.
 
+(`derivepassphrase` currently is a `vault` reimplementation, but also plans to [support other passphrase derivation schemes][OTHER_DERIVATION_SCHEMES] in the future.)
+
 [VAULT]: https://www.npmjs.com/package/vault
+[OTHER_DERIVATION_SCHEMES]: https://the13thletter.info/derivepassphrase/0.x/wishlist/other-derivation-schemes/ "Wish entry: Consider implementing passphrase schemes other than vault's"
 
 -----
 
@@ -22,7 +25,7 @@ The service name and constraints themselves also need not be kept secret; the la
 (`pip` is distributed with Python 3 by default.)
 
 `derivepassphrase` requires Python 3.9 or higher as well as the [typing-extensions package][TYPING_EXTENSIONS] for its core functionality and programmatic interface, and [`click`][CLICK] 8.1 or higher for its command-line interface.
-On Python 3.9 and 3.10 only, `derivepassphrase` additionally requires the [tomli package][TOMLI].
+Some old Python versions also require backports for the Python standard library: the [`tomli` package][TOMLI] for Python 3.9 and 3.10, and the [`exceptiongroup` backport][EXCEPTIONGROUP] for Python 3.9, 3.10 and 3.11.
 The installer should take care of installing these dependencies automatically for you.
 Using the `export vault` subcommand additionally requires the [cryptography package][CRYPTOGRAPHY], version 38.0 or newer.
 This must be separately requested at installation, via the `export` extra.
@@ -51,6 +54,7 @@ This must be separately requested at installation, via the `export` extra.
 [TYPING_EXTENSIONS]: https://pypi.org/project/typing-extensions/
 [CLICK]: https://pypi.org/project/click/
 [TOMLI]: https://pypi.org/project/tomli/
+[EXCEPTIONGROUP]: https://pypi.org/project/exceptiongroup/
 [CRYPTOGRAPHY]: https://pypi.org/project/cryptography/
 [VENV]: https://docs.python.org/3/library/venv.html
 
@@ -87,8 +91,8 @@ JKeet7GeBpxysOgdCEJo6UzmP8A0Ih
 
 ### SSH agent support
 
-On UNIX-like systems with OpenSSH or PuTTY installed, you can use an Ed25519, Ed448 or RSA key from the agent instead of a master passphrase.
-([On Windows there are problems establishing communication channels with the agent.][BUG_WINDOWS_SSH_AGENT_SUPPORT])
+On systems with OpenSSH or PuTTY installed, you can use an Ed25519, Ed448 or RSA key from the agent instead of a master passphrase.
+(Though see [agent-specific notes][AGENT_SPECIFIC_NOTES] for commentary.)
 
 ```` shell-session
 $ derivepassphrase vault -k my-email-account
@@ -114,7 +118,7 @@ $ derivepassphrase vault my-email-account
 oXDGCvMhLWPQyCzYtaobOq2Wh9olYj
 ````
 
-[BUG_WINDOWS_SSH_AGENT_SUPPORT]: https://the13thletter.info/derivepassphrase/0.x/wishlist/windows-ssh-agent-support/ "Bug entry: Support PuTTY/Pageant (and maybe OpenSSH/ssh-agent) on Windows"
+[AGENT_SPECIFIC_NOTES]: https://the13thletter.info/derivepassphrase/0.x/reference/prerequisites-ssh-key/#agent-specific-notes "Prerequisites for using derivepassphrase vault with an SSH key: agent-specific notes"
 
 ## License
 

docs/changelog.d/20251130_102427_the-13th-letter_ssh_agent_socket_providers.md

Zeige Datei @ 863e371

@@ -3,7 +3,8 @@
   - The error message "Cannot connect to an SSH agent because this Python
     version does not support UNIX domain sockets." (code: `NO_AF_UNIX`) now
     reads "Cannot connect to an SSH agent because this Python version does
-    not support communicating with it." and a new code (`NO_AGENT_SUPPORT`).
+    not support communicating with it." and has a new code
+    (`NO_AGENT_SUPPORT`).
     `derivepassphrase` may also try out certain communication channels
     (depending on the installation environment), and issue warnings relating
     to its failure to establish communication on those channels, before

mkdocs.yml

Zeige Datei @ 863e371

@@ -5,7 +5,7 @@ edit_uri: 'raw/master/docs/'
 repo_name: the-13th-letter/derivepassphrase
 site_description: An almost faithful Python reimplementation of James Coglan's vault.
 site_author: Marco Ricci
-copyright: Copyright &copy; 2025 Marco Ricci (the-13th-letter)
+copyright: Copyright &copy; 2026 Marco Ricci (the-13th-letter)
 
 remote_branch: documentation-tree
 remote_name: '.'


...	...	@@ -12,7 +12,10 @@ The derivation is also deterministic, given the same inputs, thus the resultin
12	12
13	13	The service name and constraints themselves also need not be kept secret; the latter are usually stored in a world-readable file to ease repeated entry of passphrase constraints.
14	14
	15	+(`derivepassphrase` currently is a `vault` reimplementation, but also plans to [support other passphrase derivation schemes][OTHER_DERIVATION_SCHEMES] in the future.)
	16	+
15	17	[VAULT]: https://www.npmjs.com/package/vault
	18	+[OTHER_DERIVATION_SCHEMES]: https://the13thletter.info/derivepassphrase/0.x/wishlist/other-derivation-schemes/ "Wish entry: Consider implementing passphrase schemes other than vault's"
16	19
17	20	-----
18	21
...	...	@@ -22,7 +25,7 @@ The service name and constraints themselves also need not be kept secret; the la
22	25	(`pip` is distributed with Python 3 by default.)
23	26
24	27	`derivepassphrase` requires Python 3.9 or higher as well as the [typing-extensions package][TYPING_EXTENSIONS] for its core functionality and programmatic interface, and [`click`][CLICK] 8.1 or higher for its command-line interface.
25		-On Python 3.9 and 3.10 only, `derivepassphrase` additionally requires the [tomli package][TOMLI].
	28	+Some old Python versions also require backports for the Python standard library: the [`tomli` package][TOMLI] for Python 3.9 and 3.10, and the [`exceptiongroup` backport][EXCEPTIONGROUP] for Python 3.9, 3.10 and 3.11.
26	29	The installer should take care of installing these dependencies automatically for you.
27	30	Using the `export vault` subcommand additionally requires the [cryptography package][CRYPTOGRAPHY], version 38.0 or newer.
28	31	This must be separately requested at installation, via the `export` extra.
...	...	@@ -51,6 +54,7 @@ This must be separately requested at installation, via the `export` extra.
51	54	[TYPING_EXTENSIONS]: https://pypi.org/project/typing-extensions/
52	55	[CLICK]: https://pypi.org/project/click/
53	56	[TOMLI]: https://pypi.org/project/tomli/
	57	+[EXCEPTIONGROUP]: https://pypi.org/project/exceptiongroup/
54	58	[CRYPTOGRAPHY]: https://pypi.org/project/cryptography/
55	59	[VENV]: https://docs.python.org/3/library/venv.html
56	60
...	...	@@ -87,8 +91,8 @@ JKeet7GeBpxysOgdCEJo6UzmP8A0Ih
87	91
88	92	### SSH agent support
89	93
90		-On UNIX-like systems with OpenSSH or PuTTY installed, you can use an Ed25519, Ed448 or RSA key from the agent instead of a master passphrase.
91		-([On Windows there are problems establishing communication channels with the agent.][BUG_WINDOWS_SSH_AGENT_SUPPORT])
	94	+On systems with OpenSSH or PuTTY installed, you can use an Ed25519, Ed448 or RSA key from the agent instead of a master passphrase.
	95	+(Though see [agent-specific notes][AGENT_SPECIFIC_NOTES] for commentary.)
92	96
93	97	```` shell-session
94	98	$ derivepassphrase vault -k my-email-account
...	...	@@ -114,7 +118,7 @@ $ derivepassphrase vault my-email-account
114	118	oXDGCvMhLWPQyCzYtaobOq2Wh9olYj
115	119	````
116	120
117		-[BUG_WINDOWS_SSH_AGENT_SUPPORT]: https://the13thletter.info/derivepassphrase/0.x/wishlist/windows-ssh-agent-support/ "Bug entry: Support PuTTY/Pageant (and maybe OpenSSH/ssh-agent) on Windows"
	121	+[AGENT_SPECIFIC_NOTES]: https://the13thletter.info/derivepassphrase/0.x/reference/prerequisites-ssh-key/#agent-specific-notes "Prerequisites for using derivepassphrase vault with an SSH key: agent-specific notes"
118	122
119	123	## License
120	124

...	...	@@ -3,7 +3,8 @@
3	3	- The error message "Cannot connect to an SSH agent because this Python
4	4	version does not support UNIX domain sockets." (code: `NO_AF_UNIX`) now
5	5	reads "Cannot connect to an SSH agent because this Python version does
6		- not support communicating with it." and a new code (`NO_AGENT_SUPPORT`).
	6	+ not support communicating with it." and has a new code
	7	+ (`NO_AGENT_SUPPORT`).
7	8	`derivepassphrase` may also try out certain communication channels
8	9	(depending on the installation environment), and issue warnings relating
9	10	to its failure to establish communication on those channels, before

...	...	@@ -5,7 +5,7 @@ edit_uri: 'raw/master/docs/'
5	5	repo_name: the-13th-letter/derivepassphrase
6	6	site_description: An almost faithful Python reimplementation of James Coglan's vault.
7	7	site_author: Marco Ricci
8		-copyright: Copyright © 2025 Marco Ricci (the-13th-letter)
	8	+copyright: Copyright © 2026 Marco Ricci (the-13th-letter)
9	9
10	10	remote_branch: documentation-tree
11	11	remote_name: '.'
12	12