This Python module is a minimal wapper around the cbor-diag crate_.
Unlike the crate,
which offers lots of functionality for manipulating an AST,
this module only exposes two very simple functions:
diag2cbor, which parses diagnostic notation and produces a corresponding CBOR binary string, andcbor2diag, which does the inverse.It is recommended to use the cbor2_ package to actually process the CBOR data.
Documentation is available on readthedocs_.
This project can be installed from PyPI_;
binary wheels are available there for the common platforms.
This package is considered feature-complete at release, and maintainened reactively -- when changes to the ecosystem threaten to make it unusable.
New features are only expected to be added
if they are already present in the underlying cbor-diag crate_,
and will likely manifest as extra arguments to cbor2diag.
This package is built using maturin_ and pyo3_
and largely follows their template.
The built module is renamed from cbor_diag to _cbor_diag
(and consequently wrapped manually)
to avoid it being part of the package's public API.
(The need for the workaround is tracked at maturin_ and through there in the typing module_).
The package is currently hosted on GitHub at https://github.com/chrysn/cbor-diag-py
because maturin can not yet_ build pipelines for GitLab or codeberg.
This package was written by Christian Amsüss chrysn@fsfe.org, and is published under the terms of MIT_ or Apache-2.0_ license, at the user's choice.
Credit for its functionality goes to Nemo157
as the maintainer of the underlying cbor-diag crate_.
.. _cbor-diag crate: https://crates.io/crates/cbor-diag
.. _cbor2: https://pypi.org/project/cbor2/
.. _on readthedocs: https://cbor-diag.readthedocs.io/
.. _from PyPI: https://pypi.org/project/cbor-diag/
.. _maturin: https://www.maturin.rs/
.. _pyo3: https://pyo3.rs/
.. _at maturin: https://github.com/PyO3/maturin/issues/1399
.. _in the typing module: https://github.com/python/typing/issues/1333
.. _not yet: https://github.com/PyO3/maturin/issues/1507
.. _MIT: https://spdx.org/licenses/MIT.html
.. _Apache-2.0: https://spdx.org/licenses/Apache-2.0.html
FAQs
Conversion between CBOR and CBOR Diagnostic Notation
We found that cbor-diag demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.