py-cid 0.3.0

Description:

pycid 0.3.0

CID (Content IDentifier)





What is CID ?
CID is a format for referencing content in distributed information systems,
like IPFS.
It leverages content addressing,
cryptographic hashing, and
self-describing formats.
It is the core identifier used by IPFS and IPLD.
CID is a self-describing content-addressed identifier.
It uses cryptographic hashes to achieve content addressing.
It uses several multiformats to achieve flexible self-description,
namely multihash for hashes,
multicodec for data content
types, and multibase to encode the CID itself into strings.


Sample Usage
>>> 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:
$ 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.


From sources
The sources for CID can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/ipld/py-cid
Or download the tarball:
$ curl -OL https://github.com/ipld/py-cid/tarball/master
Once you have a copy of the source, you can install it with:
$ python setup.py install



Other info

Free software: MIT license
Documentation: https://py-cid.readthedocs.io.
Python versions: 3.5, 3.6




History

0.2.1 (2018-10-20)

Fix edge cases with multibase and multihash decoding
Added hypothesis tests while verifying CIDs



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.