Metadata-Version: 1.1
Name: py-multicodec
Version: 0.1.3
Summary: Multicodec implementation in Python
Home-page: https://github.com/multiformats/py-multicodec
Author: Dhruv Baldawa
Author-email: dhruv@dhruvb.com
License: MIT license
Description-Content-Type: UNKNOWN
Description: py-multicodec
        -------------
        
        .. image:: https://img.shields.io/pypi/v/py-multicodec.svg
                :target: https://pypi.python.org/pypi/py-multicodec
        
        .. image:: https://img.shields.io/travis/multiformats/py-multicodec.svg?branch=master
                :target: https://travis-ci.org/multiformats/py-multicodec?branch=master
        
        .. image:: https://codecov.io/gh/multiformats/py-multicodec/branch/master/graph/badge.svg
                :target: https://codecov.io/gh/multiformats/py-multicodec
        
        .. image:: https://readthedocs.org/projects/py-multicodec/badge/?version=stable
                :target: https://py-multicodec.readthedocs.io/en/stable/?badge=stable
                :alt: Documentation Status
        
        
        `Multicodec <https://github.com/multiformats/multicodec>`_ implementation in Python
        
        ``multicodec`` *is a self-describing multiformat*, it wraps other formats with a tiny bit of self-description.
        
        A multicodec identifier is both a varint and the code identifying the following data, this means that the most
        significant bit of every multicodec code is reserved to signal the continuation.
        
        You can check `the table here <https://github.com/multiformats/multicodec/blob/7c57cd4477e391d27b8d7cc0995da9e674434ffb/table.csv>`_ for the list of supported codecs by ``py-multicodec``.
        
        * Free software: MIT license
        * Documentation: https://py-multicodec.readthedocs.io.
        * Python versions: 3.5, 3.6
        
        
        Installation
        ============
        
        .. code-block:: shell
        
            $ pip install py-multicodec
        
        
        Sample Usage
        ============
        
        .. code-block:: python
        
            >>> from multicodec import add_prefix, remove_prefix, get_codec
            >>> # adding a prefix to existing data
            >>> add_prefix('sha2-256', 'EiC5TSe5k00')
            b'\x12EiC5TSe5k00'
            >>> # removing prefix from prefixed data
            >>> remove_prefix(b'\x12EiC5TSe5k00')
            EiC5TSe5k00
            >>> # get codec used to prefix the prefixed data
            >>> get_codec(b'\x12EiC5TSe5k00')
            'sha2-256'
        
        
        =======
        History
        =======
        
        0.1.3 (2018-10-20)
        ------------------
        
        * Handle exception when the varint is invalid
        
        0.1.0 (2017-09-03)
        ------------------
        
        * First release on PyPI.
        
Keywords: multicodec
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
