dag-cbor: A Python implementation of the DAG-CBOR codec
This is a fully compliant Python implementation of the DAG-CBOR codec, a subset of the Concise Binary Object Representation (CBOR) supporting the IPLD Data Model and enforcing a unique (strict) encoded representation of items.
You can install the latest release from PyPI as follows:
$ pip install --upgrade dag-cborWe suggest you import DAG-CBOR as follows:
>>> import dag_cbor
Below are some basic usage examples, to get you started: for detailed documentation, see https://dag-cbor.readthedocs.io/
>>> dag_cbor.encode({'a': 12, 'b': 'hello!'}) b'xa2aax0cabfhello!' >>> dag_cbor.decode(b'xa2aax0cabfhello!') {'a': 12, 'b': 'hello!'}
>>> import pprint # pretty-printing >>> custom_opts = dict(min_codepoint=0x41, max_codepoint=0x5a, include_cid=False) >>> with dag_cbor.random.options(**custom_opts): ... for d in dag_cbor.random.rand_dict(3): ... pprint.pp(d) ... {'BIQPMZ': b'x85x1fx07/xccx00xfcxaa', 'EJEYDTZI': {}, 'PLSG': {'G': 'JFG', 'HZE': -61.278, 'JWDRKRGZ': b'-', 'OCCKQPDJ': True, 'SJOCTZMK': False}, 'PRDLN': 39.129, 'TUGRP': None, 'WZTEJDXC': -69.933} {'GHAXI': 39.12, 'PVUWZLC': 4.523, 'TDPSU': 'TVCADUGT', 'ZHGVSNSI': [-57, 9, -78.312]} {'': 11, 'B': True, 'FWD': {}, 'GXZBVAR': 'BTDWMGI', 'TDICHC': 87}
For the full API documentation, see https://dag-cbor.readthedocs.io/
Please see CONTRIBUTING.md.