Skip to content

Latest commit

 

History

History
285 lines (177 loc) · 6.58 KB

CHANGELOG.md

File metadata and controls

285 lines (177 loc) · 6.58 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Removed

  • Removed glob_scanner() and glob_filter() functions.

Documentation

  • Removed black badge from documentation.
  • Rewrited docs/release.py script using click.

Linting

  • Removed pyupgrade.
  • Removed black.
  • Adopted ruff format.

Testing

  • Preferred exclude_also over exclude_lines for coverage.

6.1 - 2023-11-30

Added

  • Added expand_path() function.
  • Added auto_glob() function.
  • Added --auto option to provide an alternative file selection method.

Changed

  • Now --sync option supports nanoseconds timestamp without precision loss.

Removed

  • Removed PathWithSuffix class.

Documentation

  • Added --no-clean and --no-dist options to docs/release.py script.

Linting

  • Adopted more ruff rules.

Testing

  • Added test cases for gethash.utils.strxor.
  • Improved tox config.
  • Now store hypothesis and pytest cache in .cache directory.

6.0 - 2023-11-19

Added

  • Added AggOutput, SepOutput and NullOutput classes.

Changed

  • Changed Output to abstract base class.
  • Refactored CRC32 class.
  • Now CheckHashLineError requires hexadecimal hash value string.
  • Refactored format_hash_line() and parse_hash_line().

Configuration

  • Added Python 3.12 support.
  • Dropped Python 3.8 support.

Documentation

  • Updated project links.

Linting

  • Adopted check-case-conflict and check-merge-conflict for pre-commit-hooks.
  • Updated mymy configuration.
  • Now store ruff and mypy cache in .cache directory.

Testing

  • Added test cases for gethash.wrappers.crc32.
  • Added more test data.
  • Adopted more-itertools for testing.
  • Improved tox config.

5.9 - 2023-10-30

Changed

  • Now Hasher supports pathlib.Path.
  • Now HashFileReader and HashFileWriter support pathlib.Path.
  • Now format_hash_line(), parse_hash_line(), generate_hash_line() and check_hash_line() support pathlib.Path.

Configuration

  • Migrated build system from setuptools to hatch.
  • Now use hatch to setup development environment.
  • Now require importlib-metadata>=4.10.
  • Now require natsort>=8.4.
  • Now require tqdm>=4.66.
  • Now require typing-extensions>=4.4.

Documentation

  • Improved documentation.
  • Improved changelog.

5.8 - 2023-10-24

Configuration

  • Now allow to setup development environment via tox devenv -e dev .venv.
  • Adopted typing-extensions.

Documentation

  • Migrated documentation dependencies to setup.cfg.
  • Updated docs/release.py script.
  • Updated docs/source/conf.py.
  • Refactored root doc from index.rst to index.md.
  • Added pre-commit and ruff badges to documentation.
  • Removed isort badge from documentation.
  • Changed title for HTML documentation to {project} {release}.
  • Improved changelog.

Testing

  • Now require tox>=4.4.
  • Fixed and improved configuration for tox.
  • Added exclude lines for coverage.
  • Added more test cases.

5.7 - 2023-10-21

Configuration

  • Migrated development dependencies to setup.cfg.
  • Now require importlib-metadata>=4.4.

Linting

  • Now require pre-commit>=3.0.
  • Adopted ruff.
  • Removed isort, flake8 and yesqa.

5.6 - 2022-10-19

Configuration

  • Migrated development dependencies to requirements-dev.txt.
  • Now require click>=8.1.

Documentation

  • Added docs/release.py script for building documentation.
  • Improved documentation.

Linting

  • Adopted yesqa.

Testing

  • Adopted coverage, pytest, pytest-cov and tox for testing.

5.5 - 2022-07-17

Added

  • Added gethash.wrappers package.
  • Added WrappersBackend class for loading commands from gethash.wrappers.

Changed

  • Moved crc32 module from gethash.utils to gethash.wrappers.
  • Improved type annotations.

Linting

  • Adopted pyupgrade.

5.4 - 2022-06-24

Added

  • Added HashContext protocol class for annotating hash context type.
  • Added gethash.backends entry points.

Changed

  • Changed type annotation of ctx argument from Any to HashContext.
  • Now load backends via entry points.

Configuration

  • Added Python 3.11 support.

Linting

  • Adopted flake8-comprehensions and flake8-simplify.
  • Migrated mypy configuration to pyproject.toml.

5.3 - 2022-06-05

Changed

  • Changed type annotations for Hasher.__init__().
  • Renamed argument of Hasher.__init__() from tqdm_class to tqdm_type.
  • --start and --stop options now require non-negative integers.

Fixed

  • Fixed a reading error when chunksize < 0 for Hasher._hash_file().

Configuration

  • Dropped Python 3.7 support.

Linting

  • Adopted pre-commit for running linters automatically.
  • Adopted flake8-bugbear and flake8-implicit-str-concat.

5.2 - 2022-05-16

Added

  • Added root argument to HashFileReader.iter_hash().

Configuration

  • Now require natsort>=8.1.
  • Removed setup.py. Now use python -m build.

5.1 - 2022-01-18

Configuration

  • Now require tqdm>=4.60.
  • Now require importlib-metadata>=4.4; python_version < "3.10".

Documentation

  • Adopted myst-parser for writing Markdown documentation.
  • Added changelog to documentation.

5.0 - 2021-12-24

Added

  • Added backends for hashlib and pycryptodome.

Removed

  • Removed sorted_locale() function.
  • Removed entry points for legacy commands.

Configuration

  • Now require click>=8.0.
  • Removed colorama>=0.4; platform_system == "Windows" dependency.
  • Switched dependency from pycryptodomex to pycryptodome.
  • Added PyPI classifier Intended Audience :: Developers.