Skip to content

Commit

Permalink
Update README to reference new RFC 8949
Browse files Browse the repository at this point in the history
  • Loading branch information
Sekenre committed Jun 4, 2021
1 parent c55426e commit 9f30439
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 6 deletions.
16 changes: 11 additions & 5 deletions README.rst
@@ -1,6 +1,9 @@
.. image:: https://travis-ci.com/agronholm/cbor2.svg?branch=master
:target: https://travis-ci.com/agronholm/cbor2
:alt: Build Status
.. image:: https://github.com/agronholm/cbor2/actions/workflows/codeqa-test.yml/badge.svg
:target: https://github.com/agronholm/cbor2/actions/workflows/codeqa-test.yml
:alt: Testing Status
.. image:: https://github.com/agronholm/cbor2/actions/workflows/publish.yml/badge.svg
:target: https://github.com/agronholm/cbor2/actions/workflows/publish.yml
:alt: Publish Status
.. image:: https://coveralls.io/repos/github/agronholm/cbor2/badge.svg?branch=master
:target: https://coveralls.io/github/agronholm/cbor2?branch=master
:alt: Code Coverage
Expand All @@ -12,13 +15,14 @@ About
=====

This library provides encoding and decoding for the Concise Binary Object Representation (CBOR)
(`RFC 7049`_) serialization format. `Read the docs <https://cbor2.readthedocs.io/>`_ to learn more.
(`RFC 8949`_) serialization format. The specification is fully compatible with the original RFC 7049.
`Read the docs <https://cbor2.readthedocs.io/>`_ to learn more.

It is implemented in pure python with an optional C backend.

On PyPy, cbor2 runs with almost identical performance to the C backend.

.. _RFC 7049: https://tools.ietf.org/html/rfc7049
.. _RFC 8949: https://www.rfc-editor.org/rfc/rfc8949.html

Features
--------
Expand All @@ -27,6 +31,7 @@ Features
* Support many `CBOR tags`_ with `stdlib objects`_.
* Generic tag decoding.
* `Shared value`_ references including cyclic references.
* `String references`_ compact encoding with repeated strings replaced with indices.
* Optional C module backend tested on big- and little-endian architectures.
* Extensible `tagged value handling`_ using ``tag_hook`` and ``object_hook`` on decode and ``default`` on encode.
* Command-line diagnostic tool, converting CBOR file or stream to JSON ``python -m cbor2.tool``
Expand All @@ -36,6 +41,7 @@ Features
.. _CBOR tags: https://www.iana.org/assignments/cbor-tags/cbor-tags.xhtml
.. _stdlib objects: https://cbor2.readthedocs.io/en/latest/usage.html#tag-support
.. _Shared value: http://cbor.schmorp.de/value-sharing
.. _String references: http://cbor.schmorp.de/stringref
.. _tagged value handling: https://cbor2.readthedocs.io/en/latest/customizing.html#using-the-cbor-tags-for-custom-types

Installation
Expand Down
7 changes: 7 additions & 0 deletions docs/versionhistory.rst
Expand Up @@ -5,6 +5,13 @@ Version history

This library adheres to `Semantic Versioning <http://semver.org/>`_.

**5.4.0** (2021-06-04)

- Fix various bounds checks in the C-backend (Sekenre)
- More testing of invalid/corrupted data (Sekenre)
- Support for `String References <http://cbor.schmorp.de/stringref>`_ (xurtis)
- Update Docs to refer to new RFC8949

**5.3.0** (2021-05-18)

- Removed support for Python < 3.6
Expand Down
2 changes: 1 addition & 1 deletion tests/test_decoder.py
Expand Up @@ -369,7 +369,7 @@ def test_bad_datetime(impl):


def test_positive_bignum(impl):
# Example from RFC 7049 section 3.4.3.
# Example from RFC 8949 section 3.4.3.
decoded = impl.loads(unhexlify('c249010000000000000000'))
assert decoded == 18446744073709551616

Expand Down

0 comments on commit 9f30439

Please sign in to comment.