https://github.com/ipld/py-cid
Python implementation of the CID specification
https://github.com/ipld/py-cid
cid python
Last synced: 10 months ago
JSON representation
Python implementation of the CID specification
- Host: GitHub
- URL: https://github.com/ipld/py-cid
- Owner: ipld
- License: mit
- Created: 2017-09-05T17:26:43.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-08-27T02:35:06.000Z (10 months ago)
- Last Synced: 2025-08-27T11:00:29.072Z (10 months ago)
- Topics: cid, python
- Language: Python
- Homepage:
- Size: 105 KB
- Stars: 36
- Watchers: 11
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
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 `_ 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
============
.. 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