v2.0.2

Bug fixes

• fix: Switch import location (7948fc2)

  In Python 3.9, typing.Sequence was deprecated in favor of
  collections.abc.Sequence (see PEP 585).

Continuous integration

• ci: pre-commit auto-update (8f5df54)

  updates:

  • github.com/astral-sh/ruff-pre-commit: v0.7.4 → v0.8.3

v2.0.1

Chores

• chore(deps): Bump the github-actions-dependencies group with 2 updates (dd049b9)

  Bumps the github-actions-dependencies group with 2 updates: github/codeql-action and pypa/gh-action-pypi-publish.

  Updates github/codeql-action from 3.27.6 to 3.27.9

  • Release notes
  • Changelog
  • Commits

  Updates pypa/gh-action-pypi-publish from 1.12.2 to 1.12.3

  • Release notes
  • Commits

  ---

  updated-dependencies:

  • dependency-name: github/codeql-action
    dependency-type: direct:production
    update-type: version-update:semver-patch
    dependency-group: github-actions-dependencies
  • dependency-name: pypa/gh-action-pypi-publish
    dependency-type: direct:production
    update-type: version-update:semver-patch
    dependency-group: github-actions-dependencies
    ...

  Signed-off-by: dependabot[bot] [email protected]

• chore(deps): Bump the github-actions-dependencies group with 3 updates (17b1247)

  Bumps the github-actions-dependencies group with 3 updates: github/codeql-action, codecov/codecov-action and python-semantic-release/python-semantic-release.

  Updates github/codeql-action from 3.27.5 to 3.27.6

  • Release notes
  • Changelog
  • Commits

  Updates codecov/codecov-action from 5.0.7 to 5.1.1

  • Release notes
  • Changelog
  • Commits

  Updates python-semantic-release/python-semantic-release from 9.15.0 to 9.15.1

  • Release notes
  • Changelog
  • Commits

  ---

  updated-dependencies:

  • dependency-name: github/codeql-action
    dependency-type: direct:production
    update-type: version-update:semver-patch
    dependency-group: github-actions-dependencies
  • dependency-name: codecov/codecov-action
    dependency-type: direct:production
    update-type: version-update:semver-minor
    dependency-group: github-actions-dependencies
  • dependency-name: python-semantic-release/python-semantic-release
    dependency-type: direct:production
    update-type: version-update:semver-patch
    dependency-group: github-actions-dependencies
    ...

  Signed-off-by: dependabot[bot] [email protected]

Patch

• patch: Support Python 3.13 (453fd05)

v2.0.0

Chores

• chore!: Drop support for Python 3.8 (5c448ec)

  • Use the type-hinting provided out of the box in 3.9.
  • Remove version guards around argparse.BooleanOptionalAction.
  • Update documentation and CI accordingly.

• chore(deps): Bump python-semantic-release/python-semantic-release (ac3702c)

  Bumps the github-actions-dependencies group with 1 update: python-semantic-release/python-semantic-release.

  Updates python-semantic-release/python-semantic-release from 9.14.0 to 9.15.0

  • Release notes
  • Changelog
  • Commits

  ---

  updated-dependencies:

  • dependency-name: python-semantic-release/python-semantic-release
    dependency-type: direct:production
    update-type: version-update:semver-minor
    dependency-group: github-actions-dependencies
    ...

  Signed-off-by: dependabot[bot] [email protected]

• chore(deps): Bump the github-actions-dependencies group with 4 updates (7f8c1df)

  Bumps the github-actions-dependencies group with 4 updates: step-security/harden-runner, github/codeql-action, codecov/codecov-action and actions/dependency-review-action.

  Updates step-security/harden-runner from 2.10.1 to 2.10.2

  • Release notes
  • Commits

  Updates github/codeql-action from 3.27.4 to 3.27.5

  • Release notes
  • Changelog
  • Commits

  Updates codecov/codecov-action from 5.0.2 to 5.0.7

  • Release notes
  • Changelog
  • Commits

  Updates actions/dependency-review-action from 4.4.0 to 4.5.0

  • Release notes
  • Commits

  ---

  updated-dependencies:

  • dependency-name: step-security/harden-runner
    dependency-type: direct:production
    update-type: version-update:semver-patch
    dependency-group: github-actions-dependencies
  • dependency-name: github/codeql-action
    dependency-type: direct:production
    update-type: version-update:semver-patch
    dependency-group: github-actions-dependencies
  • dependency-name: codecov/codecov-action
    dependency-type: direct:production
    update-type: version-update:semver-patch
    dependency-group: github-actions-dependencies
  • dependency-name: actions/dependency-review-action
    dependency-type: direct:production
    update-type: version-update:semver-minor
    dependency-group: github-actions-dependencies
    ...

  Signed-off-by: dependabot[bot] [email protected]

• chore(deps): Bump the github-actions-dependencies group with 3 updates (dc2383e)

  Bumps the github-actions-dependencies group with 3 updates: github/codeql-action, codecov/codecov-action and python-semantic-release/python-semantic-release.

  Updates github/codeql-action from 3.27.1 to 3.27.4

  • Release notes
  • Changelog
  • Commits

  Updates codecov/codecov-action from 4.6.0 to 5.0.2

  • Release notes
  • Changelog
  • Commits

  Updates python-semantic-release/python-semantic-release from 9.13.0 to 9.14.0

  • Release notes
  • Changelog
  • Commits

  ---

  updated-dependencies:

  • dependency-name: github/codeql-action
    dependency-type: direct:production
    update-type: version-update:semver-patch
    dependency-group: github-actions-dependencies
  • dependency-name: codecov/codecov-action
    dependency-type: direct:production
    update-type: version-update:semver-major
    dependency-group: github-actions-dependencies
  • dependency-name: python-semantic-release/python-semantic-release
    dependency-type: direct:production
    update-type: version-update:semver-minor
    dependency-group: github-actions-dependencies
    ...

  Signed-off-by: dependabot[bot] [email protected]

• chore(deps): Bump the github-actions-dependencies group with 3 updates (dc6341e)

  Bumps the github-actions-dependencies group with 3 updates: github/codeql-action, python-semantic-release/python-semantic-release and pypa/gh-action-pypi-publish.

  Updates github/codeql-action from 3.27.0 to 3.27.1

  • Release notes
  • Changelog
  • Commits

  Updates python-semantic-release/python-semantic-release from 9.12.0 to 9.13.0

  • Release notes
  • Changelog
  • Commits

  Updates pypa/gh-action-pypi-publish from 1.11.0 to 1.12.2

  • Release notes
  • Commits

  ---

  updated-dependencies:

  • dependency-name: github/codeql-action
    dependency-type: direct:production
    update-type: version-update:semver-patch
    dependency-group: github-actions-dependencies
  • dependency-name: python-semantic-release/python-semantic-release
    dependency-type: direct:production
    update-type: version-update:semver-minor
    dependency-group: github-actions-dependencies
  • dependency-name: pypa/gh-action-pypi-publish
    dependency-type: direct:production
    update-type: version-update:semver-minor
    dependency-group: github-actions-dependencies
    ...

  Signed-off-by: dependabot[bot] [email protected]

• chore(deps): Bump the github-actions-dependencies group with 2 updates (4570ba6)

  Bumps the github-actions-dependencies group with 2 updates: actions/dependency-review-action and pypa/gh-action-pypi-publish.

  Updates actions/dependency-review-action from 4.3.5 to 4.4.0

  • Release notes
  • Commits

  Updates pypa/gh-action-pypi-publish from 1.10.3 to 1.11.0

  • Release notes
  • Commits

  ---

  updated-dependencies:

  • dependency-name: actions/dependency-review-action
    dependency-type: direct:production
    update-type: version-update:semver-minor
    dependency-group: github-actions-dependencies
  • dependency-name: pypa...

v1.0.8

Chore

• chore: Remove commitizen configuration (73ceec1)

• chore: Remove commitizen pre-commit hook (18c274f)

  In order to enable a faster development workflow, remove the commitizen
  pre-commit hook to allow commits messages that don't adhere to the
  Conventional Commits specification. Commit messages are still checked
  in the Continuous Integration workflow, though, so a branch will need to
  be clean before merging.

Continuous Integration

• ci: pre-commit auto-update (31ce94a)

  updates:

  • github.com/astral-sh/ruff-pre-commit: v0.4.2 → v0.4.3

• ci: pre-commit auto-update (7438097)

  updates:

  • github.com/astral-sh/ruff-pre-commit: v0.4.1 → v0.4.2
  • github.com/pre-commit/mirrors-mypy: v1.9.0 → v1.10.0

Documentation

• docs: Fix license/copyright text in file (1d496c1)

  Should have been included in b355341,
  but was overlooked.

• docs: Reword Conventional Commits guidelines (6659b11)

• docs: Add code lines badge (9e4953d)

Patch

• patch: Indicate that the package is typed (bd89c55)

  According to PEP 561, we need to add this file to static type checkers
  can infer the types from the package.

Test

• test: Ignore assert warnings in test files (01f97d0)

v1.0.7

Chore

• chore: Ignore security findings in tests/examples (f18ece4)

• chore: Switch to Ruff (6112943)

  Use Ruff to replace a variety of linters/formatters.

• chore: Fix badge URLs (2c8dda1)

  Somehow it looks like some hidden character wound up copy/pasted in the
  middle of the https.

• chore: Add PR template (eb0b3b8)

Continuous Integration

• ci: pre-commit auto-update (0b14008)

  updates:

  • github.com/commitizen-tools/commitizen: v3.22.0 → v3.24.0

• ci: Add OpenSSF Scorecard workflow (5f8f3cf)

• ci: pre-commit auto-update (f184590)

  updates:

  • github.com/commitizen-tools/commitizen: v3.21.3 → v3.22.0
  • github.com/psf/black: 24.3.0 → 24.4.0

• ci: pre-commit auto-update (d91334d)

  updates:

  • github.com/pre-commit/pre-commit-hooks: v4.5.0 → v4.6.0

• ci: pre-commit auto-update (43b5104)

  updates:

  • github.com/commitizen-tools/commitizen: v3.20.0 → v3.21.3

• ci: pre-commit auto-update (60cefa8)

  updates:

  • github.com/commitizen-tools/commitizen: v3.18.4 → v3.20.0

• ci: pre-commit auto-update (155240b)

  updates:

  • github.com/commitizen-tools/commitizen: v3.15.0 → v3.18.4
  • github.com/pre-commit/mirrors-mypy: v1.8.0 → v1.9.0
  • github.com/psf/black: 24.2.0 → 24.3.0
  • github.com/PyCQA/bandit: 1.7.7 → 1.7.8

• ci: pre-commit auto-update (ef525b7)

  updates:

  • github.com/commitizen-tools/commitizen: v3.14.1 → v3.15.0

• ci: pre-commit auto-update (5e0e1b4)

  updates:

  • github.com/psf/black: 24.1.1 → 24.2.0

• ci: pre-commit auto-update (b6e239d)

  updates:

  • github.com/commitizen-tools/commitizen: v3.13.0 → v3.14.1

• ci: auto fixes from pre-commit.com hooks (2d05e81)

  for more information, see https://pre-commit.ci

• ci: pre-commit auto-update (5150bc1)

  updates:

  • github.com/psf/black: 23.12.1 → 24.1.1
  • github.com/PyCQA/bandit: 1.7.6 → 1.7.7

Documentation

• docs: Add docstrings to test/example files (f0b7eb9)

• docs: Add OpenSSF Scorecard badge to ReadTheDocs (91c5557)

• docs: Add CodeFactor badge (105a394)

• docs: Adopt Conventional Comments (9d16c0c)

  Try to encourage effective communication via issues/PRs.

• docs: Update link to latest GMS release (af2ce45)

• docs: Move copyright/license text to comments (b355341)

  In all source files, move the copyright and license text from the module
  docstring to comments immediately below it. This is to avoid processing
  this text when Sphinx is automatically generating documentation from
  docstrings.

• docs: Add contributor license agreement (9531c94)

• docs: Update copyright text in source files (4cba3d0)

  Per guidance from Sandia Technology Transfer, the recommended text from
  the Linux Foundation is insufficient for our purposes.

• docs: Update copyright/license info (4d1d42a)

  Update the copyright years in the LICENSE.md file and add copyright
  and license information to all source files (part of the Gold level
  OpenSSF Best Practices).

• docs: Add coverage job steps (3b20a84)

  Add steps to the CI job to compute the documentation coverage for the
  package and archive the results.

Patch

• patch: Force prefer_short to be keyword-only (f02c7f2)

  Turning on flake8-boolean-trap linting via Ruff resulted in the
  following findings:

  reverse_argparse/reverse_argparse.py:242:31:
  FBT002 Boolean default positional argument in function definition
  reverse_argparse/reverse_argparse.py:242:31:
  FBT001 Boolean-typed positional argument in function definition
  Found 2 errors.
  

  Switching prefer_short from a positional to a keyword-only argument
  addresses the problem.

  Note that this is technically a breaking change, but only for a
  "private" method, not in the package's public API. Therefore the change
  is not registered as a breaking change via Conventional Commit syntax,
  and no major version update will be created. Instead, this commit will
  force the creation of a patch release. If users were relying on the
  prior behavior of this internal method, they can simply switch to the
  keyword syntax when calling it.

Refactor

• refactor: Address Ruff-specific lint findings (076e199)

• refactor: Address Pylint findings (862bc62)

• refactor: Ignore particular type error (9d412dd)

• refactor: Remove unnecessary shebang lines (a7ae1f6)

• refactor: Assign exception messages to variables (844c71a)

  Running flake8-errmsg via Ruff yielded the following findings:

  reverse_argparse/reverse_argparse.py:143:17:
  EM102 Exception must not use an f-string literal, assign to variable
  first
  reverse_argparse/reverse_argparse.py:461:17:
  EM102 Exception must not use an f-string literal, assign to variable
  first
  Found 2 errors.
  

  This changes resolves the issues.

• refactor: Don't override Python builtins (9006adb)

Test

• test: Use tuples for parametrize variables (25d9be8)

• test: Use UTC timezone with datetime (25ff30f)

  Running flake8-datetimez via Ruff yielded the following findings:

  example/test_examples.py:88:25:
  DTZ005 `datetime.datetime.now()` called without a `tz` argument
  example/test_examples.py:89:25:
  DTZ007 Naive datetime constructed using
  `datetime.datetime.strptime()` without %z
  example/test_examples.py:125:13:
  DTZ005 `datetime.datetime.now()` called without a `tz` argument
  example/test_examples.py:126:25:
  DTZ007 Naive datetime constructed using
  `datetime.datetime.strptime()` without %z
  

  ...

v1.0.6

Continuous Integration

• ci: pre-commit auto-update (47bb274)

  updates:

  • github.com/PyCQA/flake8: 6.1.0 → 7.0.0

• ci: pre-commit auto-update (9d3e11a)

  updates:

  • github.com/pre-commit/mirrors-mypy: v1.7.1 → v1.8.0
  • github.com/psf/black: 23.11.0 → 23.12.1
  • github.com/PyCQA/isort: 5.13.0 → 5.13.2

• ci: pre-commit auto-update (48da6a4)

  updates:

  • github.com/PyCQA/bandit: 1.7.5 → 1.7.6
  • github.com/PyCQA/isort: 5.12.0 → 5.13.0

• ci: pre-commit auto-update (a5591e4)

  updates:

  • github.com/commitizen-tools/commitizen: 3.12.0 → v3.13.0

• ci: pre-commit auto-update (5d80e7d)

  updates:

  • github.com/pre-commit/mirrors-mypy: v1.7.0 → v1.7.1

• ci: pre-commit auto-update (bbc7a4e)

  updates:

  • github.com/pre-commit/mirrors-mypy: v1.6.1 → v1.7.0
  • github.com/psf/black: 23.10.1 → 23.11.0

• ci: pre-commit auto-update (4c5b060)

  updates:

  • github.com/psf/black: 23.10.0 → 23.10.1

Documentation

• docs: Add more badges (629857d)

  Add additional badges to capture things like contributions, the
  conda-forge release channel, etc.

• docs: Include badges in ReadTheDocs (e30fc68)

  Include the badges from the README in the index page of our
  documentation so this information is visible on ReadTheDocs in addition
  to GitHub and PyPI.

  Closes #81.

• docs: Private vulnerability reporting (9d6a758)

  Remove the security issue template and instead direct people to file a
  private security advisory.

Patch

• patch: Add a badge for the CodeQL action (2d77837)

  Create a patch release to push all these new badges out to PyPI.

v1.0.5

Chore

• chore: Update python-semantic-release config (9972341)

  • Add commit types to automatically bump the minor or patch version
    numbers via a commit message.
  • Update commitizen configuration to allow the new commit types.

• chore: Add Python 3.12 to pyproject.toml (ef59c2d)

  This was accidentally omitted in
  6642a17.

• chore: Remove YAPF configuration (ad02127)

  We switched to black back in #5.

Continuous Integration

• ci: pre-commit auto-update (cb014b7)

  updates:

  • github.com/commitizen-tools/commitizen: 3.10.1 → 3.12.0
  • github.com/pre-commit/mirrors-mypy: v1.6.0 → v1.6.1
  • github.com/psf/black: 23.9.1 → 23.10.0
  • github.com/PyCQA/prospector: 1.10.2 → v1.10.3

• ci: pre-commit auto-update (568c816)

  updates:

  • github.com/commitizen-tools/commitizen: 3.10.0 → 3.10.1
  • github.com/pre-commit/mirrors-mypy: v1.5.1 → v1.6.0

• ci: pre-commit auto-update (b57dc9f)

  updates:

  • github.com/pre-commit/pre-commit-hooks: v4.4.0 → v4.5.0

• ci: Add Python 3.12 to CI (f03f4dc)

  Also update the version badge to specify particular versions.

• ci: pre-commit auto-update (d9fc077)

  updates:

  • github.com/commitizen-tools/commitizen: 3.9.0 → 3.10.0

• ci: pre-commit auto-update (e97c276)

  updates:

  • github.com/commitizen-tools/commitizen: 3.8.2 → 3.9.0

• ci: pre-commit auto-update (87d1f7e)

  updates:

  • github.com/commitizen-tools/commitizen: 3.7.1 → 3.8.2
  • github.com/psf/black: 23.7.0 → 23.9.1

• ci: pre-commit auto-update (b750046)

  updates:

  • github.com/commitizen-tools/commitizen: 3.7.0 → 3.7.1

• ci: pre-commit auto-update (b50b368)

  updates:

  • github.com/commitizen-tools/commitizen: 3.6.0 → 3.7.0

• ci: pre-commit auto-update (989ba52)

  updates:

  • github.com/pre-commit/mirrors-mypy: v1.5.0 → v1.5.1

• ci: Fix pre-commit auto-update message (6475b1f)

  Ensure the commit message used by the pre-commit auto-update bot adheres
  to the Conventional Commits specification.

• ci: pre-commit autoupdate (08fe531)

  updates:

  • github.com/commitizen-tools/commitizen: 3.5.3 → 3.6.0
  • github.com/pre-commit/mirrors-mypy: v1.4.1 → v1.5.0
  • github.com/PyCQA/flake8: 6.0.0 → 6.1.0

Documentation

• docs: Remove dependency pinning (b14034f)

  I should be the case that the bugs that kept us on an older version of
  Sphinx have been resolved at this point, so remove the version pinning.

• docs: Add sphinx-copybutton (2122825)

  Automatically add a button to all code boxes to copy the contents to the
  clipboard.

• docs: Fix typos (eb05c2c)

• docs: Special thanks to @mjsumpter (6cc3054)

  Include @mjsumpter in the Credits section at the bottom of the
  README, as he put together a prior iteration of this concept under my
  guidance. His earlier implementation informed the eventual creation of
  this package.

• docs: Add CI details to contributing guidelines (b8269bf)

• docs: Check spelling (b72ee11)

  Add sphinxcontrib-spelling extension to check the spelling in our
  documentation, and add a step to the CI job to ensure all is well.

• docs: Add OpenSSF Best Practices badge (604fb61)

• docs: Fix copy/paste issue (2f6517a)

• docs: pre-commit install instructions (063d8f9)

Patch

• patch: Add release notes template (a447eac)

  • Create a template to govern the generation of release notes by
    python-semantic-release.
  • Bump the patch version number to test that this works as expected.

Test

• test: Run examples in CI (6642a17)

  Create example/test_examples.py so pytest runs all the examples and
  checks their output.

v1.0.4

v1.0.4 (2023-07-25)

Fix

• fix: PyPI badge (1581e2a)

v1.0.3

v1.0.3 (2023-07-25)

Fix

• fix: Semantic release configuration (a73688c)

v1.0.2

v1.0.2 (2023-07-24)

Ci

• ci: Remove -vv for semantic-release (d83ae5d)

Fix

• fix: Release notes template (1ac839a)

• fix: Semantic release configuration

• Add __init__.py to the files modified.

• Fix the __version__ in that file.

• Remove trailing space in CHANGELOG template.

• Add build command.

• Make release commit match conventional standard.

• Add release notes template.

• Publish releases to PyPI and GitHub Releases. (0325dc0)