README.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334
  1. simplejson
  2. ----------
  3. simplejson is a simple, fast, complete, correct and extensible
  4. JSON <http://json.org> encoder and decoder for Python 3.3+
  5. with legacy support for Python 2.5+. It is pure Python code
  6. with no dependencies, but includes an optional C extension
  7. for a serious speed boost.
  8. The latest documentation for simplejson can be read online here:
  9. https://simplejson.readthedocs.io/
  10. simplejson is the externally maintained development version of the
  11. json library included with Python (since 2.6). This version is tested
  12. with the latest Python 3.8 and maintains backwards compatibility
  13. with Python 3.3+ and the legacy Python 2.5 - Python 2.7 releases.
  14. The encoder can be specialized to provide serialization in any kind of
  15. situation, without any special support by the objects to be serialized
  16. (somewhat like pickle). This is best done with the ``default`` kwarg
  17. to dumps.
  18. The decoder can handle incoming JSON strings of any specified encoding
  19. (UTF-8 by default). It can also be specialized to post-process JSON
  20. objects with the ``object_hook`` or ``object_pairs_hook`` kwargs. This
  21. is particularly useful for implementing protocols such as JSON-RPC
  22. that have a richer type system than JSON itself.
  23. For those of you that have legacy systems to maintain, there is a
  24. very old fork of simplejson in the `python2.2`_ branch that supports
  25. Python 2.2. This is based on a very old version of simplejson,
  26. is not maintained, and should only be used as a last resort.
  27. .. _python2.2: https://github.com/simplejson/simplejson/tree/python2.2