Recent commits to derivepassphrase.git (4eb85f64c8f18a55eb83c3909322a78b11ba6c87)

Add a specific error class and codes for SSH agent failures

2024-08-16T13:27:20+02:00

Add the generic `SSH_AGENT_FAILURE` and `SSH_AGENT_SUCCESS` status codes
(as `_types.SSH_AGENT.FAILURE` and `_types.SSH_AGENT.SUCCESS`,
respectively), and add an `SSHAgentFailedError` class to signal error
returns from the SSH agent. The error class may emit a specific or
a generic error message, depending on the status code and error message
passed.

Rewrite the tests to use actual failure status codes, instead of random
magic numbers. Rewrite it further to deal with the `_types.SSH_AGENT`
enum instead of numeric codes. This also makes the tests more readable.
</pre>

Document and handle other errors passed through to the command-line interface

2024-08-16T12:48:10+02:00

These errors have already been passed through, but they were neither
documented nor explicitly handled in the command-line interface with an
appropriate error message.
</pre>

Use better error message handling in the command-line interface

2024-08-16T12:38:08+02:00

Instead of blindly relying on `click.Context.fail`, which causes a usage
message to be printed, implement our own error-exit function.

Furthermore, since writing the configuration file is prone to similar
problems as reading it, include a wrapper for writing the configuration
file as well, which ensures errors are properly reported.

Due to the rewrite, some error messages changed slightly in phrasing
and/or in capitalization.
</pre>

Merge topic branch 'restructure-package' into master

2024-08-03T21:53:16+02:00

* t/restructure-package:
  Prune empty subpackages `sequin` and `ssh_agent`
  Update documentation to use new module names
  Annotate settings and selections in pyproject.toml
  Consolidate `types` submodules into combined `_types` submodule
  Move `sequin` and `ssh_agent_client` submodules below `derivepassphrase`

GitHub: Closes #3, closes #7.
</pre>

Prune empty subpackages `sequin` and `ssh_agent`

2024-08-03T21:49:33+02:00

Turn them back into normal submodules of `derivepassphrase`, instead of
subpackages.
</pre>

Update documentation to use new module names

2024-08-03T21:48:58+02:00

Let the documentation reflect the moving and splitting of modules in
26973402aac5d216a66ae3fc8f2d7bcb0fd7ea89.  The filenames are still
mostly the same, to keep links alive where possible.

Because the module list is now more tree-like than list-like, yet still
very small as a whole, abandon the table format in favor of a hierarchy
of (Markdown/HTML) lists.
</pre>

Annotate settings and selections in pyproject.toml

2024-07-28T22:44:39+02:00

Annotate all extra dependencies or configuration choices that I may
otherwise forget the reasoning for in the long run.
</pre>

Consolidate `types` submodules into combined `_types` submodule

2024-07-28T22:26:40+02:00

Merge the submodules `types` and `ssh_agent.types` into a new submodule
`_types`.  This naming avoids a clash with the standard library, which
in turn causes bizarre import errors when other code tries to import and
then introspect the parent modules.

Due to the new and shorter naming, some module or package imports have
been rephrased, which causes deceivingly large-looking formatting
changes.
</pre>

Move `sequin` and `ssh_agent_client` submodules below `derivepassphrase`

2024-07-28T21:32:08+02:00

These modules were already strongly coupled to `derivepassphrase`, and
prone to namespace collisions (particularly `ssh_agent_client`).
Furthermore, maintaining the author and version information in three
top-level modules is error-prone.

A direct inclusion of `sequin` and `ssh_agent_client` revealed
a circular import, so the bulk of `derivepassphrase` was delegated to
a new submodule `derivepassphrase.vault`.  This also yields a cleaner
import graph.  Also, because the shorter name makes more sense in this
context, rename `derivepassphrase.ssh_agent_client` to
`derivepassphrase.ssh_agent`.

The two `types` submodules are not yet consolidated.
</pre>

Add Material settings for versioning

2024-07-28T20:51:10+02:00

...most notably, the "outdated version" warning.
</pre>