derivepassphrase.git

@@ -0,0 +1,5 @@

+### Added

+

+  - Convert changelog management from towncrier to [scriv][].

+

+[scriv]: https://pypi.org/project/scriv

@@ -0,0 +1,7 @@

+### Added

+

+  - Add SSH agent spawning support to the test suite.  Use this support to

+    test the agent functionality on all known major SSH agent

+    implementations automatically. ([#12])

+

+[#12]: https://github.com/the-13th-letter/derivepassphrase/issues/12

@@ -0,0 +1,5 @@

+### Added

+

+  - Add [hypothesis][]-based tests to the test suite.

+

+[hypothesis]: https://pypi.org/project/hypothesis/

@@ -28,48 +28,53 @@ effectively constitute a new <q>major</q> release.)

   [REFERENCE]: reference/index.md

-<!-- towncrier release notes start -->

+<!-- scriv changelog start -->

 ## 0.2.0 (2024-09-12)

-#### Added

+### Added

-- Support configuration data export from `vault` in v0.2, v0.3 and storeroom

-  formats.

+  - Support configuration data export from `vault` in v0.2, v0.3 and

+    storeroom formats.

     This feature requires the `cryptography` Python module, but is available

     even if `vault` is not installed. ([#1])

 [#1]: https://github.com/the-13th-letter/derivepassphrase/1

-#### Fixed

+### Fixed

-- Deploy versioned documentation with [mike](https://pypi.org/project/mike).

-  Set up a "latest" tag and the "0.<var>x</var>" version of the documentation

-  with the contents so far.

+  - Deploy versioned documentation with [mike][].  Set up a "latest" tag and

+    the "0.<var>x</var>" version of the documentation with the contents so

+    far.

-#### Changed

+[mike]: https://pypi.org/project/mike

+

+### Changed

   - Changed `sequin` and `ssh_agent_client` to be submodules of

     `derivepassphrase`.  Further moved `derivepassphrase.Vault` and

-  `derivepassphrase.AmbiguousByteRepresentation` into a new submodule `vault`,

-  and renamed submodule `ssh_agent_client` to `ssh_agent`. ([#3])

-- Changed internal error handling and error messages, to better work in the

-  context of a command-line tool. ([#4])

+    `derivepassphrase.AmbiguousByteRepresentation` into a new submodule

+    `vault`, and renamed submodule `ssh_agent_client` to `ssh_agent`. ([#3])

+  - Changed internal error handling and error messages, to better work in

+    the context of a command-line tool. ([#4])

   - Combine and consolidate `derivepassphrase.types` and

     `derivepassphrase.ssh_agent.types` into a new submodule

-  `derivepassphrase._types`.  Despite the name, the module is public. ([#7])

+    `derivepassphrase._types`.  Despite the name, the module is public.

+    ([#7])

   - Warn the user when entering (directly, or via configuration

     editing/importing) a passphrase that is not in the configured Unicode

     normalization form. (But don't otherwise reject any textual master

     passphrases.) ([#9])

-- Move all existing functionality into a subcommand, in anticipation of other

-  passphrase derivation schemes, with different settings.  Automatically

-  forward calls without a subcommand to the "vault" subcommand.

+  - Move all existing functionality into a subcommand, in anticipation of

+    other passphrase derivation schemes, with different settings.

+    Automatically forward calls without a subcommand to the "vault"

+    subcommand.

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

-  instead of globally.  Automatically fall back to, and migrate, the old global

-  settings file if no subsystem-specific configuration was found. ([#10])

+    instead of globally.  Automatically fall back to, and migrate, the old

+    global settings file if no subsystem-specific configuration was found.

+    ([#10])

   - Make `derivepassphrase_export` a subcommand: `derivepassphrase export`.

     ([#11])

@@ -81,7 +86,7 @@ effectively constitute a new <q>major</q> release.)

 [#10]: https://github.com/the-13th-letter/derivepassphrase/10

 [#11]: https://github.com/the-13th-letter/derivepassphrase/11

-#### Deprecated

+### Deprecated

   - Using the implied subcommand or the implied global configuration file is

     deprecated, and will be removed in v1.0.

@@ -89,14 +94,15 @@ effectively constitute a new <q>major</q> release.)

 ## 0.1.3 (2024-07-28)

-#### Fixed

+### Fixed

-- Do not crash upon selecting a key on the command-line if there already is a

-  key stored in the configuration. ([#5])

-- Create the configuration directory upon saving, if it does not yet exist.

-  ([#6])

-- Isolate the tests properly and consistently from the user's configuration, so

-  that user configuration problems do not cause unrelated test failures. ([#8])

+  - Do not crash upon selecting a key on the command-line if there already

+    is a key stored in the configuration. ([#5])

+  - Create the configuration directory upon saving, if it does not yet

+    exist.  ([#6])

+  - Isolate the tests properly and consistently from the user's

+    configuration, so that user configuration problems do not cause

+    unrelated test failures. ([#8])

   - Add an alternate MkDocs configuration for building the documentation in

     offline mode.

   - Fix typing issues according to `mypy`'s strict mode.

@@ -108,32 +114,33 @@ effectively constitute a new <q>major</q> release.)

 ## 0.1.2 (2024-07-22)

-#### Fixed

+### Fixed

   - Include and exclude the correct files in the `sdist` and `wheel`

-  distributions.  (Previously, `sdist` contained VCS artifacts, and `wheel` was

-  missing some paths.)

+    distributions.  (Previously, `sdist` contained VCS artifacts, and

+    `wheel` was missing some paths.)

   - Lint and reformat all code using [ruff](https://astral.sh/ruff/).

-- Mention [`mkdocstrings-python`](https://mkdocstrings.github.io/python/) in

-  the documentation's page footer.

-- Remove JavaScript and external font loading from documentation website, so

-  that the site works even in restricted browser settings.

-- Set up a changelog, using [towncrier](https://pypi.org/package/towncrier).

+  - Mention [`mkdocstrings-python`](https://mkdocstrings.github.io/python/)

+    in the documentation's page footer.

+  - Remove JavaScript and external font loading from documentation website,

+    so that the site works even in restricted browser settings.

+  - Set up a changelog, using

+    [towncrier](https://pypi.org/package/towncrier).

 ## 0.1.1 (2024-07-14)

-#### Fixed

+### Fixed

   - Restore the `__version__` attribute in all top-level packages.

   - Declare compatibility with Python 3.10 in project metadata, and include

     necessary version-specific dependencies.

-- Publish the documentation online, and link to it in the repository metadata

-  and the Python package metadata.

+  - Publish the documentation online, and link to it in the repository

+    metadata and the Python package metadata.

 ## 0.1.0 (2024-07-14)

-#### Added

+### Added

   - Initial release.

@@ -89,7 +89,7 @@ omit = [

 [tool.hatch.build.targets.sdist]

 exclude = [

-    'towncrier.d/[0123456789+]*.md',

+    'docs/changelog.d/*.md',

 ]

 [tool.hatch.build.targets.wheel]

@@ -157,7 +157,7 @@ cov-report = "coverage report"

 [tool.hatch.envs.release]

 extra-dependencies = [

-  "towncrier >= 23.11"

+  "scriv >= 1.4"

 ]

 [tool.hatch.envs.release.scripts]

@@ -326,43 +326,12 @@ max-doc-length = 72  # for W505

 [tool.ruff.lint.pydocstyle]

 convention = 'google'

-[tool.towncrier]

-package = 'derivepassphrase'

-package_dir = 'src'

-directory = 'towncrier.d'

-filename = 'docs/changelog.md'

-template = 'towncrier-template.md'

-#title_format = '[{version}](https://github.com/the-13th-letter/derivepassphrase/tree/{version}) – {project_date}'

-underlines = ['', '', '']

-issue_format = '[#{issue}]: https://github.com/the-13th-letter/derivepassphrase/{issue}'

-wrap = true

-

-[[tool.towncrier.type]]

-directory = "security"

-name = "Security"

-showcontent = true

-

-[[tool.towncrier.type]]

-directory = "added"

-name = "Added"

-showcontent = true

-

-[[tool.towncrier.type]]

-directory = "fixed"

-name = "Fixed"

-showcontent = true

-

-[[tool.towncrier.type]]

-directory = "removed"

-name = "Removed"

-showcontent = true

-

-[[tool.towncrier.type]]

-directory = "changed"

-name = "Changed"

-showcontent = true

-

-[[tool.towncrier.type]]

-directory = "deprecated"

-name = "Deprecated"

-showcontent = true

+[tool.scriv]

+version = "command: hatch version"

+format = "md"

+fragment_directory = "docs/changelog.d"

+output_file = "docs/changelog.md"

+insert_marker = "<!-- scriv changelog start -->"

+end_marker = "<!-- scriv changelog end -->"

+md_header_level = "2"

+entry_title_template = "{% if version %}{{ version }} ({% endif %}{{ date.strftime('%Y-%m-%d') }}{% if version %}){% endif %}"

@@ -1,54 +0,0 @@

-{% if render_title %}

-## {{ versiondata.version }} ({{ versiondata.date }})

-{% endif %}

-{% for section, _ in sections.items() %}

-{% if section %}

-

-### {{section}}

-{% endif %}

-

-{% if sections[section] %}

-{% for category, val in definitions.items() if category in sections[section] %}

-#### {{ definitions[category]['name'] }}

-

-{% for text, values in sections[section][category].items() %}

-- {{ text }}

-{%- if values %}

-{% if "\n  - " in text or '\n  * ' in text %}

-

-

-  (

-{%- else %}

-{% if text %} ({% endif %}

-{%- endif -%}

-{%- for issue in values %}

-{{ issue.split(": ", 1)[0] }}{% if not loop.last %}, {% endif %}

-{%- endfor %}

-{% if text %}){% endif %}

-

-{% else %}

-

-{% endif %}

-{% endfor %}

-

-{% if issues_by_category[section][category] and "]: " in issues_by_category[section][category][0] %}

-{% for issue in issues_by_category[section][category] %}

-{{ issue }}

-{% endfor %}

-

-{% endif %}

-{% if sections[section][category]|length == 0 %}

-No significant changes.

-

-{% else %}

-{% endif %}

-{% endfor %}

-{% else %}

-No significant changes.

-

-{% endif %}

-{% endfor +%}

-{#

-This comment adds one more newline at the end of the rendered newsfile content.

-In this way the there are 2 newlines between the latest release and the previous release content.

-#}

@@ -1 +0,0 @@

-Add [hypothesis](https://pypi.org/project/hypothesis/)-based tests to the test suite.

@@ -1 +0,0 @@

-Add SSH agent spawning support to the test suite.  Use this support to test the agent functionality on all known major SSH agent implementations automatically.