diff options
| author | Michael Williamson <mike@zwobble.org> | 2013-06-19 11:22:00 +0100 |
|---|---|---|
| committer | Michael Williamson <mike@zwobble.org> | 2013-06-19 11:22:00 +0100 |
| commit | a3cfb19c4448d97fc0036e2fee10506d94a88fef (patch) | |
| tree | 38c7af3a00917cc1286351ccaa1d201c866b96cd | |
| parent | 20a73a5f293492b9490f4fec3a060cc173c879f8 (diff) | |
Add README.md
| -rw-r--r-- | README.md | 16 | ||||
| -rw-r--r-- | setup.py | 2 |
2 files changed, 17 insertions, 1 deletions
@@ -0,0 +1,16 @@ +# jq.py: a lightweight and flexible JSON processor + +Warning: this project is not production-ready. +There are almost certainly a number of memory leaks and the API is not stable. + +This project contains Python bindings for (jq)[http://stedolan.github.io/jq/]. + +## Examples + +```python +from jq import jq + +assert [2, 3, 4] == jq("[.[]+1]").transform_json([1, 2, 3]).json() +assert [2,3,4] == str(jq("[.[]+1]").transform_json([1, 2, 3])) +assert [2,3,4] == str(jq("[.[]+1]").transform_string("[1, 2, 3]")) +``` @@ -53,7 +53,7 @@ jq_extension = Extension( setup( name='jq', version='0.1.0', - description='jq is a lightweight and flexible command-line JSON processor.', + description='jq is a lightweight and flexible JSON processor.', long_description=read("README"), author='Michael Williamson', url='http://github.com/mwilliamson/jq.py', |
