Skip to content

Commit 87b40e6

Browse files
committed
Small documentation updates.
1 parent e10a0bb commit 87b40e6

File tree

2 files changed

+30
-9
lines changed

2 files changed

+30
-9
lines changed

Diff for: README.md

+26-1
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,35 @@
55

66
![py_yyjson Logo](misc/logo_small.png)
77

8-
Fast, flexible Python bindings for the excellent [yyjson][] project.
8+
Fast and flexible Python JSON parsing built on the excellent [yyjson][]
9+
project.
10+
11+
![GitHub Sponsors](https://img.shields.io/github/sponsors/tktech)
12+
![PyPI - License](https://img.shields.io/pypi/l/yyjson)
13+
![PyPI - Version](https://img.shields.io/pypi/v/yyjson)
14+
15+
- **Fast**: `yyjson` is several times faster than the builtin JSON module, and
16+
is [faster than most other JSON libraries][fast].
17+
- **Flexible**: Parse JSON with strict specification compliance, or with
18+
extensions such as comments, trailing commas, Inf/NaN, numbers of any size,
19+
and more.
20+
- **Lightweight**: `yyjson` is a lightweight project dependency with low
21+
maintenance overhead. It's written in C, and has no dependencies other than
22+
a C89 compiler. Built wheels are between 50kb and 800kb depending on the
23+
platform.
24+
- **Portable**: Binary wheels are available for many versions of Python
25+
on many architectures, such as x86, x86_64, ARM, and ARM64, PowerPC, IBM Z,
26+
and more. PyPy is also supported. Supports Python 3.9 and newer.
27+
- **Manipulate documents**: The fastest JSON Merge-Patch (RFC 7386), JSON Patch
28+
(RFC 6902), and JSON Pointer (RFC 6901) implementations available for Python
29+
allow you to manipulate JSON documents without deserializing them into Python
30+
objects.
31+
- **Traceable**: `yyjson` uses Python's memory allocator by default, so you can
32+
trace memory leaks and other memory issues using Python's built-in tools.
933

1034
## Documentation
1135

1236
Find the latest documentation at https://tkte.ch/py_yyjson.
1337

1438
[yyjson]: https://github.com/ibireme/yyjson
39+
[fast]: https://github.com/tktech/json_benchmark

Diff for: docs/index.rst

+4-8
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77
api.rst
88
development.rst
99

10-
Python bindings to the fantastic `yyjson`_ project. This module provides a fast,
11-
flexible, portable, and correct JSON parser and serializer.
10+
Fast and flexible Python JSON parsing built on the excellent `yyjson`_ library.
1211

1312
.. image:: https://img.shields.io/github/sponsors/tktech
1413
:alt: GitHub Sponsors
@@ -78,8 +77,7 @@ Parse a JSON document from a file:
7877
7978
>>> from pathlib import Path
8079
>>> from yyjson import Document
81-
>>> doc = Document(Path("canada.json")).as_obj
82-
>>> doc
80+
>>> Document(Path("canada.json")).as_obj
8381
{'type': 'FeatureCollection', 'features': [...], 'bbox': [...], 'crs': {...}}
8482
8583
@@ -88,17 +86,15 @@ Parse a JSON document from a string:
8886
.. code-block:: python
8987
9088
>>> from yyjson import Document
91-
>>> doc = Document('{"hello": "world"}').as_obj
92-
>>> doc
89+
>>> Document('{"hello": "world"}').as_obj
9390
{'hello': 'world'}
9491
9592
Parse a JSON document from a bytes object:
9693

9794
.. code-block:: python
9895
9996
>>> from yyjson import Document
100-
>>> doc = Document(b'{"hello": "world"}').as_obj
101-
>>> doc
97+
>>> Document(b'{"hello": "world"}').as_obj
10298
{'hello': 'world'}
10399
104100

0 commit comments

Comments
 (0)