Skip to content

Commit

Permalink
doc test
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjsewell committed Jun 2, 2017
1 parent 7786243 commit 84b9cab
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 3 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,16 @@ It provides:
- Parser abstract class for dealing with converting other file formats to JSON


## Example
## Installation

pip install jsonextended

jsonextended has no import dependancies, on Python 3.x and only `pathlib2` on 2.7 but,
for full functionallity, it is advised to install the following packages:

conda install -c conda-forge ijson numpy pandas pint

## Examples

### Data Folders JSONisation

Expand Down Expand Up @@ -62,7 +71,7 @@ ejson.dict_pprint(jdict1,depth=2)
ejson.dict_to_html(jdict1,depth=3)
```

To See Rendered JSON Output: https://chrisjsewell.github.io/
To see the rendered JSON Output, seen in the Jupyter Notebook : https://chrisjsewell.github.io/

### Nested Dict Manipulation

Expand Down
21 changes: 21 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,20 @@ It provides:
- Parser abstract class for dealing with converting other file formats
to JSON

Instillation
------------

.. parsed-literal::
pip install jsonextended
jsonextended has no import dependancies, on Python 3.x and only `pathlib2` on 2.7 but,
for full functionallity, it is advised to install the following packages:

.. parsed-literal::
conda install -c conda-forge ijson numpy pandas pint
Examples
---------

Expand Down Expand Up @@ -66,6 +80,13 @@ Data Folders JSONisation
file1: {...}
dir3:
.. code:: python
ejson.dict_to_html(jdict1,depth=3)
To see the rendered JSON Output, seen in the Jupyter Notebook : https://chrisjsewell.github.io/


Nested Dict Manipulation
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion jsonextended/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
"""

__version__ = '0.1.2.13'
__version__ = '0.1.2.14'

from jsonextended.core import (get_test_path,json_keys,json_to_dict, dict_to_json,
dict_pprint,dict_extract,dict_multiindex, dict_rename_keys,
Expand Down

0 comments on commit 84b9cab

Please sign in to comment.