Skip to content

Commit

Permalink
release: 0.3.0 (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
overcat committed Jan 2, 2024
1 parent 610184b commit 8cf1649
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,4 @@ jobs:
uses: pypa/gh-action-pypi-publish@release/v1
with:
skip-existing: true
packages-dir: wheels/
packages-dir: fastcrc/
5 changes: 3 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ Change Log

This document records all notable changes to `fastcrc <https://github.com/overcat/fastcrc/>`_.

Pending
-------
0.3.0 (January 2, 2024)
-----------------------
* feat: add support for 8 bit CRCs. (`#5 <https://github.com/overcat/fastcrc/pull/5>`_)
* chore: drop support for Python 3.6. (`#6 <https://github.com/overcat/fastcrc/pull/6>`_)

0.2.1 (September 15, 2022)
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "fastcrc"
version = "0.2.1"
version = "0.3.0"
authors = ["overcat <[email protected]>"]
edition = "2018"
description = "A hyper-fast Python module for computing CRC(16, 32, 64) checksum"
Expand Down
7 changes: 4 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -29,9 +29,10 @@ Usage

.. code:: python
from fastcrc import crc16, crc32, crc64
from fastcrc import crc8, crc16, crc32, crc64
data = b"123456789"
print(f"crc8 checksum with cdma2000 algorithm: {crc8.cdma2000(data)}")
print(f"crc16 checksum with xmodem algorithm: {crc16.xmodem(data)}")
print(f"crc32 checksum with aixm algorithm: {crc32.aixm(data)}")
print(f"crc64 checksum with ecma_182 algorithm: {crc64.ecma_182(data)}")
Expand Down
7 changes: 7 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
API Reference
=============

CRC 8
-----

.. automodule:: fastcrc.crc8
:members:
:undoc-members:

CRC 16
------

Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
fastcrc==0.2.1
fastcrc==0.3.0
sphinx
2 changes: 1 addition & 1 deletion fastcrc/__info__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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__ = "[email protected]"
__license__ = "MIT License"
11 changes: 9 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>"
maintainer = "overcat <[email protected]>"
classifiers = [
Expand All @@ -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"
Expand Down

0 comments on commit 8cf1649

Please sign in to comment.