Metadata-Version: 1.1
Name: py-cid
Version: 0.2.0
Summary: Self-describing content-addressed identifiers for distributed systems
Home-page: https://github.com/ipld/py-cid
Author: Dhruv Baldawa
Author-email: dhruv@dhruvb.com
License: MIT license
Description-Content-Type: UNKNOWN
Description: CID (Content IDentifier)
        ------------------------
        
        
        .. image:: https://img.shields.io/pypi/v/py-cid.svg
                :target: https://pypi.python.org/pypi/py-cid
        
        .. image:: https://img.shields.io/travis/ipld/py-cid.svg?branch=master
                :target: https://travis-ci.org/ipld/py-cid?branch=master
        
        .. image:: https://codecov.io/gh/ipld/py-cid/branch/master/graph/badge.svg
                :target: https://codecov.io/gh/ipld/py-cid
        
        .. image:: https://readthedocs.org/projects/py-cid/badge/?version=stable
                :target: https://py-cid.readthedocs.io/en/stable/?badge=stable
                :alt: Documentation Status
        
        
        What is CID ?
        =============
        
        `CID <https://github.com/ipld/cid>`_ is a format for referencing content in distributed information systems,
        like `IPFS <https://ipfs.io>`_.
        It leverages `content addressing <https://en.wikipedia.org/wiki/Content-addressable_storage>`_,
        `cryptographic hashing <https://simple.wikipedia.org/wiki/Cryptographic_hash_function>`_, and
        `self-describing formats <https://github.com/multiformats/multiformats>`_.
        
        It is the core identifier used by `IPFS <https://ipfs.io>`_ and `IPLD <https://ipld.io>`_.
        
        CID is a self-describing content-addressed identifier.
        
        It uses cryptographic hashes to achieve content addressing.
        
        It uses several `multiformats <https://github.com/multiformats/multiformats>`_ to achieve flexible self-description,
        namely `multihash <https://github.com/multiformats/multihash>`_ for hashes,
        `multicodec <https://github.com/multiformats/multicodec>`_ for data content
        types, and `multibase <https://github.com/multiformats/multibase>`_ to encode the CID itself into strings.
        
        Sample Usage
        ============
        
        .. code-block:: python
        
            >>> from cid import make_cid
            >>> make_cid('QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L4')
            CIDv0(version=0, codec=dag-pb, multihash=b"\x12 \xb9M'\xb9\x93M>\x08\xa5.R\xd7\xda}\xab\xfa\xc4\x84..")
        
            >>> cid = make_cid('QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L4')
            >>> print(cid.version, cid.codec, cid.multihash)
        
            >>> print(cid.encode())
            QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L4
        
            >>> str(cid)
            'QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L4'
        
        
        Installation
        ============
        
        Stable release
        ~~~~~~~~~~~~~~
        
        To install CID, run this command in your terminal:
        
        .. code-block:: console
        
            $ pip install py-cid
        
        This is the preferred method to install CID, as it will always install the most recent stable release.
        
        If you don't have `pip`_ installed, this `Python installation guide`_ can guide
        you through the process.
        
        .. _pip: https://pip.pypa.io
        .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
        
        From sources
        ~~~~~~~~~~~~
        
        The sources for CID can be downloaded from the `Github repo`_.
        
        You can either clone the public repository:
        
        .. code-block:: console
        
            $ git clone git://github.com/ipld/py-cid
        
        Or download the `tarball`_:
        
        .. code-block:: console
        
            $ curl  -OL https://github.com/ipld/py-cid/tarball/master
        
        Once you have a copy of the source, you can install it with:
        
        .. code-block:: console
        
            $ python setup.py install
        
        
        .. _Github repo: https://github.com/ipld/py-cid
        .. _tarball: https://github.com/ipld/py-cid/tarball/master
        
        Other info
        ==========
        
        * Free software: MIT license
        * Documentation: https://py-cid.readthedocs.io.
        * Python versions: 3.5, 3.6
        
        
        History
        -------
        
        0.1.5 (2018-10-12)
        ==================
        
        * Handle the case where an incorrect base58 encoded value is provided to `make_cid`
        
        
        0.1.0 (2017-09-05)
        ==================
        
        * First release on PyPI.
        
Keywords: cid
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
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
