From d061ff55f38c9c31431cae4768fff380f2dac734 Mon Sep 17 00:00:00 2001
From: Jun Luo <4catcode@gmail.com>
Date: Tue, 2 Jan 2024 20:24:07 +0800
Subject: [PATCH] release: 0.3.0
---
CHANGELOG.rst | 5 +++--
Cargo.lock | 2 +-
Cargo.toml | 2 +-
README.rst | 4 ++--
docs/index.rst | 7 +++++++
docs/requirements.txt | 2 +-
fastcrc/__info__.py | 2 +-
pyproject.toml | 11 +++++++++--
8 files changed, 25 insertions(+), 10 deletions(-)
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 28dc636..e53fc3e 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -4,8 +4,9 @@ Change Log
This document records all notable changes to `fastcrc `_.
-Pending
--------
+0.3.0 (January 2, 2024)
+-----------------------
+* feat: add support for 8 bit CRCs. (`#5 `_)
* chore: drop support for Python 3.6. (`#6 `_)
0.2.1 (September 15, 2022)
diff --git a/Cargo.lock b/Cargo.lock
index f7a8589..60f1282 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -37,7 +37,7 @@ checksum = "2d0165d2900ae6778e36e80bbc4da3b5eefccee9ba939761f9c2882a5d9af3ff"
[[package]]
name = "fastcrc"
-version = "0.2.1"
+version = "0.3.0"
dependencies = [
"crc",
"paste",
diff --git a/Cargo.toml b/Cargo.toml
index 982d712..376c8d9 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "fastcrc"
-version = "0.2.1"
+version = "0.3.0"
authors = ["overcat <4catcode@gmail.com>"]
edition = "2018"
description = "A hyper-fast Python module for computing CRC(16, 32, 64) checksum"
diff --git a/README.rst b/README.rst
index b20f43a..adf16c0 100644
--- a/README.rst
+++ b/README.rst
@@ -10,11 +10,11 @@ fastcrc
:alt: PyPI
:target: https://pypi.python.org/pypi/fastcrc
-.. image:: https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-blue?style=flat
+.. image:: https://img.shields.io/badge/python-%3E%3D3.7-blue?style=flat
:alt: Python - Version
:target: https://pypi.python.org/pypi/fastcrc
-A hyper-fast Python module for computing CRC(16, 32, 64) checksum.
+A hyper-fast Python module for computing CRC(8, 16, 32, 64) checksum.
Installation
diff --git a/docs/index.rst b/docs/index.rst
index 75b6f27..2fec6b0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,6 +3,13 @@
API Reference
=============
+CRC 8
+-----
+
+.. automodule:: fastcrc.crc8
+ :members:
+ :undoc-members:
+
CRC 16
------
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 8dfa28d..d542401 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,2 +1,2 @@
-fastcrc==0.2.1
+fastcrc==0.3.0
sphinx
\ No newline at end of file
diff --git a/fastcrc/__info__.py b/fastcrc/__info__.py
index 0b1e230..4a8661d 100644
--- a/fastcrc/__info__.py
+++ b/fastcrc/__info__.py
@@ -2,7 +2,7 @@
__description__ = "A hyper-fast Python module for computing CRC(16, 32, 64) checksum"
__url__ = "https://github.com/overcat/fastcrc"
__issues__ = f"{__url__}/issues"
-__version__ = "0.2.1"
+__version__ = "0.3.0"
__author__ = "overcat"
__author_email__ = "4catcode@gmail.com"
__license__ = "MIT License"
diff --git a/pyproject.toml b/pyproject.toml
index c32ca9e..01a0cfc 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,9 +1,9 @@
[project]
name = "fastcrc"
-version = "0.2.1"
+version = "0.3.0"
requires-python = ">=3.7"
readme = "README.rst"
-description = "A hyper-fast Python module for computing CRC(16, 32, 64) checksum"
+description = "A hyper-fast Python module for computing CRC(8, 16, 32, 64) checksum"
author = "overcat <4catcode@gmail.com>"
maintainer = "overcat <4catcode@gmail.com>"
classifiers = [
@@ -21,6 +21,13 @@ classifiers = [
]
homepage = "https://github.com/overcat/fastcrc"
repository = "https://github.com/overcat/fastcrc"
+keywords = [
+ "crc",
+ "crc8",
+ "crc16",
+ "crc32",
+ "crc64",
+]
[tool.poetry.urls]
"Bug Tracker" = "https://github.com/overcat/fastcrc/issues"