crcc 2.0.3__tar.gz

crcc-2.0.3/.readthedocs.yml

@@ -0,0 +1,15 @@
+version: 2
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.13"
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true

crcc-2.0.3/CHANGES.rst

@@ -0,0 +1,132 @@
+Changelog
+=========
+
+2.0.3 (2025-11-08)
+------------------
+- | Backward INCOMPATIBILITY:
+- | rename package crc-ct -> crcc, rename module crc -> crcc
+  | (due to conflict with existing https://pypi.org/project/crc/).
+- Mark the package as typed.
+- Add tox's tool.tox.env.cleanup testenv.
+- Setup (dependencies) update and unification.
+
+1.5.0 (2025-09-01)
+------------------
+- Making the package typed.
+- Setup (dependencies) update.
+
+1.4.4 (2025-07-07)
+------------------
+- 100% code coverage.
+- Setup (dependencies) update.
+
+1.4.3 (2025-06-15)
+------------------
+- The distribution is now created using 'build' instead of 'setuptools'.
+- Setup (dependencies) update (due to regressions in tox and setuptools).
+
+1.4.1 (2025-05-04)
+------------------
+- Setup (dependencies) update.
+
+1.4.0 (2025-04-28)
+------------------
+- Add support for Python 3.14
+- Drop support for Python 3.9 (due to compatibility issues).
+- Update readthedocs's python to version 3.13
+- Update tox's base_python to version 3.13
+- Setup (dependencies) update.
+
+1.3.5 (2025-02-14)
+------------------
+- Setup (dependencies) update.
+
+1.3.4 (2025-01-20)
+------------------
+- Copyright year update.
+- Setup (dependencies) update.
+
+1.3.3 (2024-12-13)
+------------------
+- Source distribution (\*.tar.gz now) is compliant with PEP-0625.
+- 100% code linting.
+- Tox configuration is now in native (toml) format.
+- Setup (dependencies) update.
+
+1.3.2 (2024-10-30)
+------------------
+- Setup (dependencies) update.
+
+1.3.1 (2024-10-09)
+------------------
+- Setup (dependencies) update.
+
+1.3.0 (2024-09-30)
+------------------
+- Drop support for Python 3.8
+- Setup (dependencies) update.
+
+1.2.4 (2024-08-13)
+------------------
+- Add support for Python 3.13
+- Setup (dependencies) update.
+
+1.2.3 (2024-01-26)
+------------------
+- Cleanup.
+
+1.2.1 (2024-01-22)
+------------------
+- Tox configuration has been moved to pyproject.toml
+- Setup update (now based on tox >= 4.0).
+- Add support for Python 3.12
+- Drop support for Python 3.7
+- Add support for PyPy 3.9 and 3.10
+- Copyright year update.
+
+1.2.0 (2022-08-02)
+------------------
+- Add support for Python 3.10 and 3.11
+- Add support for PyPy 3.7, 3.8 and 3.9
+- Setup update (currently based mainly on pyproject.toml).
+
+1.1.0 (2022-01-10)
+------------------
+- Add support for Python 3.9.
+- Drop support for Python 3.5 and 3.6.
+- Copyright year update.
+- Setup general update and improvement.
+- General update and cleanup.
+- Fixed docs setup.
+
+1.0.0rc9 (2020-01-16)
+---------------------
+- Fix for missing include stddef.h (for size_t) in crc.h
+- Another fixes for gcc/Linux.
+- Added ReadTheDocs config file.
+- Setup update.
+
+1.0.0rc6 (2019-11-13)
+---------------------
+- Drop support for Python2.
+- Add support for Python 3.8.
+- Setup update and cleanup.
+
+1.0.0rc2 (2019-05-19)
+---------------------
+- C API has been changed in one place: crc_finalize() -> crc_final().
+- Python API has been changed. It is now finally established in the
+  folowing way; crc.name instead of crc.crc_name in most of cases.
+- Python doc-strings update.
+- Fix for error in Python definition of crc.predefined_models.
+- Python tests have been added.
+- Changes and fixes for support of Python2.
+- Minor setup improvements.
+
+1.0.0b1 (2019-05-12)
+--------------------
+- Firt beta release.
+
+0.0.1 (2017-05-09)
+------------------
+- Initial release for Python.

crcc-2.0.3/LICENSE

@@ -0,0 +1,19 @@
+zlib License
+
+Copyright (C) 1994-2025 Adam Karpierz
+
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.

crcc-2.0.3/MANIFEST.in

@@ -0,0 +1,21 @@
+# Copyright (c) 1994 Adam Karpierz
+# SPDX-License-Identifier: Zlib
+
+include README.rst
+include CHANGES.rst
+include LICENSE
+include pyproject.toml
+include .readthedocs.yml
+
+graft docs
+
+graft examples
+
+graft include
+graft src
+
+graft tests
+
+global-exclude \#* \#*/**
+global-exclude .build .build/** .build.* .build.*/**
+global-exclude *.py[cod] __pycache__ .mypy_cache

crcc-2.0.3/PKG-INFO

@@ -0,0 +1,276 @@
+Metadata-Version: 2.4
+Name: crcc
+Version: 2.0.3
+Summary: C and Python CRC calculations module.
+Author-email: Adam Karpierz <adam@karpierz.net>
+Maintainer-email: Adam Karpierz <adam@karpierz.net>
+License-Expression: Zlib
+Project-URL: Homepage, https://pypi.org/project/crcc/
+Project-URL: Documentation, https://crcc.readthedocs.io/
+Project-URL: Download, https://pypi.org/project/crcc/
+Project-URL: Source, https://github.com/karpierz/crcc
+Project-URL: Issues, https://github.com/karpierz/crcc/issues
+Keywords: crcc,crc
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: Polish
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Programming Language :: C
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: <4.0.0,>=3.10.0
+Description-Content-Type: text/x-rst; charset=UTF-8
+License-File: LICENSE
+Requires-Dist: setuptools>=80.9.0
+Requires-Dist: typing_extensions>=4.15.0
+Requires-Dist: pkg-about>=2.0.0
+Requires-Dist: py-utlx>=1.1.0
+Provides-Extra: doc
+Requires-Dist: Sphinx>=8.1.3; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints>=3.0.1; extra == "doc"
+Requires-Dist: sphinx-toolbox>=4.0.0; extra == "doc"
+Requires-Dist: sphinx-tabs>=3.4.5; extra == "doc"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
+Requires-Dist: sphinxcontrib-spelling>=8.0.1; extra == "doc"
+Requires-Dist: sphinx-lint>=1.0.1; extra == "doc"
+Requires-Dist: restructuredtext-lint>=1.4.0; extra == "doc"
+Requires-Dist: nbsphinx>=0.9.7; extra == "doc"
+Provides-Extra: test
+Requires-Dist: deepdiff>=8.6.1; extra == "test"
+Requires-Dist: rich>=14.2.0; extra == "test"
+Dynamic: license-file
+
+crcc
+====
+
+C and Python (ctypes/cffi-based) CRC calculations module.
+
+Overview
+========
+
+TBD...
+
+`PyPI record`_.
+
+`Documentation`_.
+
+Usage
+-----
+
+TBD...
+
+Installation
+============
+
+Prerequisites:
+
++ Python 3.10 or higher
+
+  * https://www.python.org/
+
++ pip and setuptools
+
+  * https://pypi.org/project/pip/
+  * https://pypi.org/project/setuptools/
+
+To install run:
+
+  .. parsed-literal::
+
+    python -m pip install --upgrade |package|
+
+Development
+===========
+
+Prerequisites:
+
++ Development is strictly based on *tox*. To install it run::
+
+    python -m pip install --upgrade tox
+
+Visit `Development page`_.
+
+Installation from sources:
+
+clone the sources:
+
+  .. parsed-literal::
+
+    git clone |respository| |package|
+
+and run:
+
+  .. parsed-literal::
+
+    python -m pip install ./|package|
+
+or on development mode:
+
+  .. parsed-literal::
+
+    python -m pip install --editable ./|package|
+
+License
+=======
+
+  | |copyright|
+  | Licensed under the zlib/libpng License
+  | https://opensource.org/license/zlib
+  | Please refer to the accompanying LICENSE file.
+
+Authors
+=======
+
+* Adam Karpierz <adam@karpierz.net>
+
+.. |package| replace:: crcc
+.. |package_bold| replace:: **crcc**
+.. |copyright| replace:: Copyright (c) 1994-2025 Adam Karpierz
+.. |respository| replace:: https://github.com/karpierz/crcc.git
+.. _Development page: https://github.com/karpierz/crcc
+.. _PyPI record: https://pypi.org/project/crcc/
+.. _Documentation: https://crcc.readthedocs.io/
+
+Changelog
+=========
+
+2.0.3 (2025-11-08)
+------------------
+- | Backward INCOMPATIBILITY:
+- | rename package crc-ct -> crcc, rename module crc -> crcc
+  | (due to conflict with existing https://pypi.org/project/crc/).
+- Mark the package as typed.
+- Add tox's tool.tox.env.cleanup testenv.
+- Setup (dependencies) update and unification.
+
+1.5.0 (2025-09-01)
+------------------
+- Making the package typed.
+- Setup (dependencies) update.
+
+1.4.4 (2025-07-07)
+------------------
+- 100% code coverage.
+- Setup (dependencies) update.
+
+1.4.3 (2025-06-15)
+------------------
+- The distribution is now created using 'build' instead of 'setuptools'.
+- Setup (dependencies) update (due to regressions in tox and setuptools).
+
+1.4.1 (2025-05-04)
+------------------
+- Setup (dependencies) update.
+
+1.4.0 (2025-04-28)
+------------------
+- Add support for Python 3.14
+- Drop support for Python 3.9 (due to compatibility issues).
+- Update readthedocs's python to version 3.13
+- Update tox's base_python to version 3.13
+- Setup (dependencies) update.
+
+1.3.5 (2025-02-14)
+------------------
+- Setup (dependencies) update.
+
+1.3.4 (2025-01-20)
+------------------
+- Copyright year update.
+- Setup (dependencies) update.
+
+1.3.3 (2024-12-13)
+------------------
+- Source distribution (\*.tar.gz now) is compliant with PEP-0625.
+- 100% code linting.
+- Tox configuration is now in native (toml) format.
+- Setup (dependencies) update.
+
+1.3.2 (2024-10-30)
+------------------
+- Setup (dependencies) update.
+
+1.3.1 (2024-10-09)
+------------------
+- Setup (dependencies) update.
+
+1.3.0 (2024-09-30)
+------------------
+- Drop support for Python 3.8
+- Setup (dependencies) update.
+
+1.2.4 (2024-08-13)
+------------------
+- Add support for Python 3.13
+- Setup (dependencies) update.
+
+1.2.3 (2024-01-26)
+------------------
+- Cleanup.
+
+1.2.1 (2024-01-22)
+------------------
+- Tox configuration has been moved to pyproject.toml
+- Setup update (now based on tox >= 4.0).
+- Add support for Python 3.12
+- Drop support for Python 3.7
+- Add support for PyPy 3.9 and 3.10
+- Copyright year update.
+
+1.2.0 (2022-08-02)
+------------------
+- Add support for Python 3.10 and 3.11
+- Add support for PyPy 3.7, 3.8 and 3.9
+- Setup update (currently based mainly on pyproject.toml).
+
+1.1.0 (2022-01-10)
+------------------
+- Add support for Python 3.9.
+- Drop support for Python 3.5 and 3.6.
+- Copyright year update.
+- Setup general update and improvement.
+- General update and cleanup.
+- Fixed docs setup.
+
+1.0.0rc9 (2020-01-16)
+---------------------
+- Fix for missing include stddef.h (for size_t) in crc.h
+- Another fixes for gcc/Linux.
+- Added ReadTheDocs config file.
+- Setup update.
+
+1.0.0rc6 (2019-11-13)
+---------------------
+- Drop support for Python2.
+- Add support for Python 3.8.
+- Setup update and cleanup.
+
+1.0.0rc2 (2019-05-19)
+---------------------
+- C API has been changed in one place: crc_finalize() -> crc_final().
+- Python API has been changed. It is now finally established in the
+  folowing way; crc.name instead of crc.crc_name in most of cases.
+- Python doc-strings update.
+- Fix for error in Python definition of crc.predefined_models.
+- Python tests have been added.
+- Changes and fixes for support of Python2.
+- Minor setup improvements.
+
+1.0.0b1 (2019-05-12)
+--------------------
+- Firt beta release.
+
+0.0.1 (2017-05-09)
+------------------
+- Initial release for Python.

crcc-2.0.3/README.rst

@@ -0,0 +1,90 @@
+crcc
+====
+
+C and Python (ctypes/cffi-based) CRC calculations module.
+
+Overview
+========
+
+TBD...
+
+`PyPI record`_.
+
+`Documentation`_.
+
+Usage
+-----
+
+TBD...
+
+Installation
+============
+
+Prerequisites:
+
++ Python 3.10 or higher
+
+  * https://www.python.org/
+
++ pip and setuptools
+
+  * https://pypi.org/project/pip/
+  * https://pypi.org/project/setuptools/
+
+To install run:
+
+  .. parsed-literal::
+
+    python -m pip install --upgrade |package|
+
+Development
+===========
+
+Prerequisites:
+
++ Development is strictly based on *tox*. To install it run::
+
+    python -m pip install --upgrade tox
+
+Visit `Development page`_.
+
+Installation from sources:
+
+clone the sources:
+
+  .. parsed-literal::
+
+    git clone |respository| |package|
+
+and run:
+
+  .. parsed-literal::
+
+    python -m pip install ./|package|
+
+or on development mode:
+
+  .. parsed-literal::
+
+    python -m pip install --editable ./|package|
+
+License
+=======
+
+  | |copyright|
+  | Licensed under the zlib/libpng License
+  | https://opensource.org/license/zlib
+  | Please refer to the accompanying LICENSE file.
+
+Authors
+=======
+
+* Adam Karpierz <adam@karpierz.net>
+
+.. |package| replace:: crcc
+.. |package_bold| replace:: **crcc**
+.. |copyright| replace:: Copyright (c) 1994-2025 Adam Karpierz
+.. |respository| replace:: https://github.com/karpierz/crcc.git
+.. _Development page: https://github.com/karpierz/crcc
+.. _PyPI record: https://pypi.org/project/crcc/
+.. _Documentation: https://crcc.readthedocs.io/

crcc-2.0.3/docs/CHANGES.rst

@@ -0,0 +1,2 @@
+.. _changes:
+.. include:: ../CHANGES.rst

crcc-2.0.3/docs/README.rst

@@ -0,0 +1 @@
+.. include:: ../README.rst

crcc-2.0.3/docs/conf.py

@@ -0,0 +1,117 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+from sphinx import application
+
+about = __import__("pkg_about").about_from_setup()
+
+def setup(app: application.Sphinx) -> None:
+    pass
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project   = about.__title__
+author    = about.__author__
+copyright = about.__copyright__
+
+# The full version, including alpha/beta/rc tags
+release = about.__version__
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+needs_sphinx = '8.1.3'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+   #'sphinx.ext.todo',
+   #'sphinx.ext.coverage',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.napoleon',
+    'sphinx_autodoc_typehints',
+   #'sphinx_toolbox',
+    'sphinx_tabs.tabs',
+    'sphinx_copybutton',
+    'sphinxcontrib.spelling',
+    'nbsphinx',
+]
+
+# Needed for e.g. linkcheck builder
+tls_verify = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The encoding of source files.
+#
+source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'bizstyle'  # 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for autodoc extension -------------------------------------------
+
+autoclass_content = 'both'
+autodoc_member_order = 'bysource'
+
+# -- Options for apidoc extension --------------------------------------------
+
+apidoc_separate_modules = True
+apidoc_module_first = True
+apidoc_output_dir = 'api'
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+# intersphinx_mapping = {'https://docs.python.org/': None}
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False

crcc-2.0.3/docs/index.rst

@@ -0,0 +1,21 @@
+crc documentation
+=================
+
+.. _readme:
+.. include:: README.rst
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   install.rst
+   userguide.rst
+   CHANGES.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`