cbors's Introduction

cbo-rs

A Python CBOR (de)serialization module, powered by Rust.

Wraps the excellent serde_cbor crate and provides a pythonic interface via pyo3.

Installation

Python>=3.5 is required due to the requirements of pyo3.

Recommended to install from PyPI, e.g.

pip install cbors

To install from source, use maturin to build a wheel from repository root.

maturin build -i python3
pip install target/wheels/*.whl

Usage

Serialize data via cbors.dumpb, deserialize via cbors.loadb.

Interface is similar to the standard library's json module.

import cbors

b = cbors.dumpb("foo")
assert(b == b"cfoo")

s = cbors.loadb(b)
assert(s = "foo")

Limitations

As this uses serde_cbor under the hood, the same limitations apply here.

Notably, tags are not currently supported (see pyfisch/cbor#3).

If this functionality is important to you, cbor2 might be a better choice.

Development

For local development, it is recommended to create a virtual environment, and build the module via maturin develop.

A Dockerfile is provided which will build and install the module and run the test suite.

If you do not want to use docker, it is recommended to use tox for testing.

Pull requests welcome!

cbors's People

Contributors

Stargazers

Watchers

cbors's Issues

Sounds like serde_cbor is no longer being maintained

In https://github.com/pyfisch/cbor author says he is archiving the code, and suggests people use ciborium or minicbor.

Benchmark against other popular Python cbor libraries

pip install can't find cbors

> pip3 install cbors
ERROR: Could not find a version that satisfies the requirement cbors (from versions: none)
ERROR: No matching distribution found for cbors

Implement tags

Support for this landed upstream, we should be able to support this and remove the caveat from the readme

Is nightly necessary?

Hi,

Considering cbors for a project I'm working on, and curious if it actually needs nightly at this point? PyO3 at least works with stable Rust these days.

Thanks!