-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adopt the Keep a Changelog format (#63)
- Loading branch information
Showing
11 changed files
with
429 additions
and
191 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md024.md | ||
MD024: | ||
# Only check sibling headings (default is false) | ||
# Set to true to conform to the Keep a Changelog format | ||
# See also https://github.com/olivierlacan/keep-a-changelog/issues/274#issuecomment-484065486 | ||
siblings_only: true |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,237 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented here. | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). | ||
This project has adhered to | ||
[Semantic Versioning](https://semver.org/spec/v2.0.0.html) since version 3.0.0. | ||
|
||
## [Unreleased] | ||
|
||
### Added | ||
|
||
- (planned: Add support for Python 3.13) | ||
- Add Read the Docs documentation (<https://github.com/hajimes/mmh3/issues/54>). | ||
- (planned: Document benchmark results | ||
(<https://github.com/hajimes/mmh3/issues/53>)). | ||
|
||
### Changed | ||
|
||
- Change the format of the changelog to conform to the Keep a Changelog | ||
standard. | ||
|
||
## [4.1.0] - 2024-01-09 | ||
|
||
### Added | ||
|
||
- Add support for Python 3.12. | ||
|
||
### Fixed | ||
|
||
- Fix issues with Bazel by changing the directory structure of the project | ||
(<https://github.com/hajimes/mmh3/issues/50>). | ||
- Fix incorrect type hints (<https://github.com/hajimes/mmh3/issues/51>). | ||
- Fix invalid results on s390x when the arg `x64arch` of `hash64` or | ||
`hash_bytes` is set to `False` (<https://github.com/hajimes/mmh3/issues/52>). | ||
|
||
## [4.0.1] - 2023-07-14 | ||
|
||
### Changed | ||
|
||
- Refactor the project structure (<https://github.com/hajimes/mmh3/issues/48>). | ||
|
||
### Fixed | ||
|
||
- Fix incorrect type hints. | ||
|
||
## [4.0.0] - 2023-05-22 | ||
|
||
The major version bump is due to the backward incompatible changes. | ||
|
||
### Added | ||
|
||
- Add experimental support for `hashlib`-compliant hasher classes | ||
(<https://github.com/hajimes/mmh3/issues/39>). Note that they are not yet | ||
fully tuned for performance. | ||
- Add support for type hints (<https://github.com/hajimes/mmh3/issues/44>). | ||
- Add wheels for more platforms (`musllinux`, `s390x`, `win_arm64`, and | ||
`macosx_universal2`). | ||
- Add a code of conduct (the ACM Code of Ethics and Professional Conduct). | ||
|
||
### Changed | ||
|
||
- Switch license from CC0 to MIT (<https://github.com/hajimes/mmh3/issues/43>). | ||
|
||
### Removed | ||
|
||
- Drop support for Python 3.7, as it will reach the end of life on 2023-06-27. | ||
- Backward incompatible changes: | ||
- A hash function now returns the same value under big-endian platforms as | ||
that under little-endian ones (<https://github.com/hajimes/mmh3/issues/47>). | ||
- Remove the `__version__` constant from the module | ||
(<https://github.com/hajimes/mmh3/issues/42>). Use `importlib.metadata` | ||
instead. | ||
|
||
## [3.1.0] - 2023-03-24 | ||
|
||
### Added | ||
|
||
- Add support for Python 3.10 and 3.11. Thanks | ||
[wouter bolsterlee](https://github.com/wbolster) and | ||
[Dušan Nikolić](https://github.com/n-dusan)! | ||
- Add support for 32-bit architectures such as `i686` and `armv7l`. From now on, | ||
`hash` and `hash_from_buffer` on these architectures will generate the same | ||
hash values as those on other environments. Thanks | ||
[Danil Shein](https://github.com/dshein-alt)! | ||
- In relation to the above, `manylinux2014_i686` wheels are now available. | ||
- Support for hashing huge data (>16GB). Thanks | ||
[arieleizenberg](https://github.com/arieleizenberg)! | ||
|
||
### Removed | ||
|
||
- Drop support for Python 3.6; remove legacy code for Python 2.x at the source | ||
code level. | ||
|
||
## [3.0.0] - 2021-02-23 | ||
|
||
### Added | ||
|
||
- Python wheels are now available, thanks to the power of | ||
[cibuildwheel](https://github.com/joerick/cibuildwheel). | ||
- Supported platforms are `manylinux1_x86_64`, `manylinux2010_x86_64`, | ||
`manylinux2014_aarch64`, `win32`, `win_amd64`, `macosx_10_9_x86_64`, and | ||
`macosx_11_0_arm64` (Apple Silicon). | ||
- Add support for newer macOS environments. Thanks | ||
[Matthew Honnibal](https://github.com/honnibal)! | ||
- Add support for Python 3.7, 3.8, and 3.9. | ||
|
||
### Changed | ||
|
||
- Migrate CI from Travis CI and AppVeyor to GitHub Actions. | ||
|
||
### Removed | ||
|
||
- Drop support for Python 2.7, 3.3, 3.4, and 3.5. | ||
|
||
## [2.5.1] - 2017-10-31 | ||
|
||
### Fixed | ||
|
||
- Bugfix for `hash_bytes`. Thanks [doozr](https://github.com/doozr)! | ||
|
||
## [2.5] - 2017-10-28 | ||
|
||
### Added | ||
|
||
- Add `hash_from_buffer`. Thanks [Dimitri Vorona](https://github.com/alendit)! | ||
- Add a keyword argument `signed`. | ||
|
||
## [2.4] - 2017-05-27 | ||
|
||
### Added | ||
|
||
- Support seeds with 32-bit unsigned integers; thanks | ||
[Alexander Maznev](https://github.com/pik)! | ||
- Support 64-bit data (under 64-bit environments) | ||
- Add unit testing and continuous integration with Travis CI and AppVeyor. | ||
|
||
### Fixed | ||
|
||
- Fix compile errors for Python 3.6 under Windows systems. | ||
|
||
## [2.3.2] - 2017-05-26 | ||
|
||
### Changed | ||
|
||
- Relicensed from public domain to CC0-1.0. | ||
|
||
## [2.3.1] - 2015-06-07 | ||
|
||
### Fixed | ||
|
||
- Fix compile errors for gcc >=5. | ||
|
||
## [2.3] - 2013-12-08 | ||
|
||
The first two commits are from [Derek Wilson](https://github.com/underrun). | ||
Thanks! | ||
|
||
### Added | ||
|
||
- Add `hash128`, which returns a 128-bit signed integer. | ||
|
||
### Fixed | ||
|
||
- Fix a misplaced operator which could cause memory leak in a rare condition. | ||
- Fix a malformed value to a Python/C API function which may cause runtime | ||
errors in recent Python 3.x versions. | ||
|
||
## [2.2] - 2013-03-03 | ||
|
||
### Added | ||
|
||
- Improve portability to support systems with old gcc (version < 4.4) such as | ||
CentOS/RHEL 5.x. (Commit from | ||
[Micha Gorelick](https://github.com/mynameisfiber). Thanks!) | ||
|
||
## [2.1] - 2013-02-25 | ||
|
||
### Added | ||
|
||
- Add `__version__` constant. Check if it exists when the following revision | ||
matters for your application. | ||
|
||
### Changed | ||
|
||
- Incorporate the revision r147, which includes robustness improvement and minor | ||
tweaks. | ||
|
||
Beware that due to this revision, **the result of 32-bit version of 2.1 is NOT | ||
the same as that of 2.0**. E.g.,: | ||
|
||
```shell | ||
>>> mmh3.hash("foo") # in mmh3 2.0 | ||
-292180858 | ||
>>> mmh3.hash("foo") # in mmh3 2.1 | ||
-156908512 | ||
``` | ||
|
||
The results of hash64 and hash_bytes remain unchanged. Austin Appleby, the | ||
author of Murmurhash, ensured this revision was the final modification to | ||
MurmurHash3's results and any future changes would be to improve performance | ||
only. | ||
|
||
## [2.0] - 2011-06-07 | ||
|
||
### Added | ||
|
||
- Support both Python 2.7 and 3.x. | ||
|
||
### Changed | ||
|
||
- Change the module interface. | ||
|
||
## [1.0] - 2011-04-27 | ||
|
||
### Added | ||
|
||
- As | ||
[Softpedia collected mmh3 1.0 on April 27, 2011](https://web.archive.org/web/20110430172027/https://linux.softpedia.com/get/Programming/Libraries/mmh3-68314.shtml), | ||
it must have been uploaded to PyPI on or slightly before this date. | ||
|
||
[unreleased]: https://github.com/hajimes/mmh3/compare/v4.1.0...HEAD | ||
[4.1.0]: https://github.com/hajimes/mmh3/compare/v4.0.1...v4.1.0 | ||
[4.0.1]: https://github.com/hajimes/mmh3/compare/v4.0.0...v4.0.1 | ||
[4.0.0]: https://github.com/hajimes/mmh3/compare/v3.1.0...v4.0.0 | ||
[3.1.0]: https://github.com/hajimes/mmh3/compare/v3.0.0...v3.1.0 | ||
[3.0.0]: https://github.com/hajimes/mmh3/compare/v2.5.1...v3.0.0 | ||
[2.5.1]: https://github.com/hajimes/mmh3/compare/v2.5...v2.5.1 | ||
[2.5]: https://github.com/hajimes/mmh3/compare/v2.4...v2.5 | ||
[2.4]: https://github.com/hajimes/mmh3/compare/v2.3.2...v2.4 | ||
[2.3.2]: https://github.com/hajimes/mmh3/compare/v2.3.1...v2.3.2 | ||
[2.3.1]: https://github.com/hajimes/mmh3/compare/v2.3...v2.3.1 | ||
[2.3]: https://github.com/hajimes/mmh3/compare/v2.2...v2.3 | ||
[2.2]: https://github.com/hajimes/mmh3/compare/v2.1...v2.2 | ||
[2.1]: https://github.com/hajimes/mmh3/compare/v2.0...v2.1 | ||
[2.0]: https://github.com/hajimes/mmh3/releases/tag/v2.0 | ||
[1.0]: https://web.archive.org/web/20110430172027/https://linux.softpedia.com/get/Programming/Libraries/mmh3-68314.shtml |
Oops, something went wrong.