Skip to content

Commit

Permalink
README: fix description
Browse files Browse the repository at this point in the history
  • Loading branch information
dcbaker committed Aug 26, 2016
1 parent 664f511 commit 78f8a63
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
JSONStreams
===========


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

Expand All @@ -19,7 +18,22 @@ The code is licensed MIT. See the included LICENSE file for the exact terms.
Description
###########

.. include:: docs/source/description.rst

JSONstreams is a package that attempts to making writing JSON in a streaming
format easier. In contrast to the core json module, this package doesn't
require building a complete tree of dicts and lists before writing, instead it
provides a straightforward way to to write a JSON document **without** building
the whole data structure ahead of time.

JSONstreams considers there to be two basic types, the JSON array and the JSON
object, which correspond to Python's list and dict respectively, and can encode
any types that the json.JSONEncoder can, or can use an subclass to handle
additional types.

The interface is designed to be context manger centric. The Stream class, and
the Array and Object classes returned by the subarray and subobject methods
(respectively), can be used as context managers or not, but use as context
managers are recommended to ensure that each container is closed properly.


Basic Usage
Expand Down

0 comments on commit 78f8a63

Please sign in to comment.