README.rst 1.53 KB
Newer Older
1 2 3 4 5 6
simplejson
----------

.. image:: https://travis-ci.org/simplejson/simplejson.svg?branch=master
    :target: https://travis-ci.org/simplejson/simplejson

7
simplejson is a simple, fast, complete, correct and extensible
8 9 10
JSON <http://json.org> encoder and decoder for Python 2.5+
and Python 3.3+.  It is pure Python code with no dependencies,
but includes an optional C extension for a serious speed boost.
11 12

The latest documentation for simplejson can be read online here:
13
https://simplejson.readthedocs.io/
14 15 16 17 18

simplejson is the externally maintained development version of the
json library included with Python 2.6 and Python 3.0, but maintains
backwards compatibility with Python 2.5.

19
The encoder can be specialized to provide serialization in any kind of
20
situation, without any special support by the objects to be serialized
21 22
(somewhat like pickle). This is best done with the ``default`` kwarg
to dumps.
23 24

The decoder can handle incoming JSON strings of any specified encoding
25 26 27 28
(UTF-8 by default). It can also be specialized to post-process JSON
objects with the ``object_hook`` or ``object_pairs_hook`` kwargs. This
is particularly useful for implementing protocols such as JSON-RPC
that have a richer type system than JSON itself.
29

30 31 32 33 34 35
For those of you that have legacy systems to maintain, there is a
very old fork of simplejson in the `python2.2`_ branch that supports
Python 2.2. This is based off of a very old version of simplejson,
is not maintained, and should only be used as a last resort.

.. _python2.2: https://github.com/simplejson/simplejson/tree/python2.2