# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-xxhash
VERSION=		3.4.1
KEYWORDS=		python
VARIANTS=		v11 v12
SDESC[v11]=		Python binding for xxHash (3.11)
SDESC[v12]=		Python binding for xxHash (3.12)
HOMEPAGE=		https://github.com/ifduyue/python-xxhash
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPI/x/xxhash
DISTFILE[1]=		xxhash-3.4.1.tar.gz:main
DF_INDEX=		1
SPKGS[v11]=		single
SPKGS[v12]=		single

OPTIONS_AVAILABLE=	PY311 PY312
OPTIONS_STANDARD=	none
VOPTS[v11]=		PY311=ON PY312=OFF
VOPTS[v12]=		PY311=OFF PY312=ON

DISTNAME=		xxhash-3.4.1

GENERATED=		yes

[PY311].USES_ON=			python:v11,sutools

[PY312].USES_ON=			python:v12,sutools

[FILE:2144:descriptions/desc.single]
python-xxhash
=============

    :alt: Github Actions Status

    :alt: Latest Version

    :alt: Supported Python versions

    :alt: License

.. _HMAC:
http://en.wikipedia.org/wiki/Hash-based_message_authentication_code
.. _xxHash: https://github.com/Cyan4973/xxHash
.. _Cyan4973: https://github.com/Cyan4973

xxhash is a Python binding for the xxHash_ library by `Yann Collet`__.

__ Cyan4973_

Installation
------------

.. code-block:: bash

   $ pip install xxhash
   
You can also install using conda:

.. code-block:: bash

   $ conda install -c conda-forge python-xxhash

Installing From Source
~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: bash

   $ pip install --no-binary xxhash xxhash

Prerequisites
++++++++++++++

On Debian/Ubuntu:

.. code-block:: bash

   $ apt-get install python-dev gcc

On CentOS/Fedora:

.. code-block:: bash

   $ yum install python-devel gcc redhat-rpm-config

Linking to libxxhash.so
~~~~~~~~~~~~~~~~~~~~~~~~

By default python-xxhash will use bundled xxHash,
we can change this by specifying ENV var XXHASH_LINK_SO:

.. code-block:: bash

   $ XXHASH_LINK_SO=1 pip install --no-binary xxhash xxhash

Usage
--------

Module version and its backend xxHash library version can be retrieved
using
the module properties VERSION AND XXHASH_VERSION respectively.

.. code-block:: python

    >>> import xxhash
    >>> xxhash.VERSION
    '2.0.0'
    >>> xxhash.XXHASH_VERSION
    '0.8.0'

This module is hashlib-compliant, which means you can use it in the same
way as ``hashlib.md5``.

    | update() -- update the current digest with an additional string
    | digest() -- return the current digest value
    | hexdigest() -- return the current digest as a string of hexadecimal
digits
    | intdigest() -- return the current digest as an integer
    | copy() -- return a copy of the current xxhash object
    | reset() -- reset state

md5 digest returns bytes, but the original xxh32 and xxh64 C APIs return
integers.
While this module is made hashlib-compliant, ``intdigest()`` is also
provided to
get the integer digest.

Constructors for hash algorithms provided by this module are ``xxh32() and
xxh64()``.



[FILE:98:distinfo]
0379d6cf1ff987cd421609a264ce025e74f346e3e145dd106c0cc2e3ec3f99a9        84220 xxhash-3.4.1.tar.gz