You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-3
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,12 @@ A Python client for [jsonstore.io](https://www.jsonstore.io/)
5
5
```bash
6
6
pip install json-store-client
7
7
```
8
+
#### An optional installation of [ujson](https://pypi.org/project/ujson/) is recommended for faster json processing.
9
+
##### Also installing [cchardet](https://pypi.org/project/cchardet/) and [aiodns](https://pypi.org/project/aiodns/) are recommended by aiohttp for faster performance.
8
10
9
11
## Usage
10
12
11
-
#### Demo of storing a Python object with json-store-client in async on [repl.it](https://repl.it/@leon332157/json-store-client-demo).
13
+
#### Demo of storing a Python json-friendly object with json-store-client in async on [repl.it](https://repl.it/@leon332157/json-store-client-demo).
12
14
13
15
```python
14
16
from json_store_client import*
@@ -73,7 +75,7 @@ Both return the client to use for data operations.
73
75
Storing data in jsonstore with a key.
74
76
75
77
###### key (str): The key to be stored on jsonstore
76
-
###### data (any): The data to be stored under the key. It can be any Python objects. Will be processed with [jsonpickle](https://github.com/jsonpickle/jsonpickle)
78
+
###### data (any): The data to be stored under the key. It can be any Python objects.
77
79
###### timeout (int): The timeout for the http request. Default 5 seconds
78
80
79
81
@@ -82,7 +84,7 @@ Storing data in jsonstore with a key.
82
84
83
85
Storing data in jsonstore with a dictionary mapping.
84
86
85
-
###### data (dict): A dict of {key(s):value(s)} to be updated. Value(s) can be any python object, will be dumped with [jsonpickle](https://github.com/jsonpickle/jsonpickle)
87
+
###### data (dict): A dict of {key(s):value(s)} to be updated.
86
88
###### timeout (int): The timeout for the http request. Default 5 seconds
87
89
88
90
> **Note:** If there is already some data stored under the key, it will be overwritten.
0 commit comments