Skip to main content

A client library for jsonstore

Project description

json-store-client

A Python client for jsonstore.io

Installation

pip install json-store-client

An optional installation of ujson is recommended for faster json processing.

Also installing cchardet and aiodns are recommended by aiohttp for faster performance.

Usage

Demo of storing a Python json-friendly object with json-store-client in async on repl.it.

import json_store_client

jsonStoreToken = '...' # Insert your token here.
client = json_store_client.AsyncClient(jsonStoreToken)
async def demo_function():
 # Save data to the 'foo' key.
 await client.store('foo', {'alfa': 'bravo', 'charlie': 'delta'})

 # Save data with dict mapping
 await client.save_multiple({'foo':{'alfa': 'bravo', 'charlie': 'delta'}})

 # Get the data from the 'foo' key.
 data = await client.retrieve('foo')

 print(data['alfa']) # => 'bravo'

 # Deletes the data after printing parts of it.
 await client.delete('foo')

json-store-client API

json_store_client.Client(token)

json_store_client.AsyncClient(token)

Returns the client to use for data operations.

token (str): The API token from jsonstore.io

client.store(key, data[, timeout])

await client.store(key, data[, timeout])

Storing data in jsonstore with a key

key (str): The key to be stored on jsonstore
data (any): The data to be stored under the key. It can be any Python objects.
timeout (int): The timeout for the http request. Default 5 seconds

client.store_multiple(data[, timeout])

await client.store_multiple(data[, timeout])

Storing data in jsonstore with a dict mapping

data (dict): A dict of {key(s):value(s)} to be updated.
timeout (int): The timeout for the http request. Default 5 seconds

client.retrieve(key[, timeout])

await clent.retrieve(key[, timeout])

Retrieve data in jsonstore with a key

If nothing is saved under the key, it will return None.
key (str): The key to get on jsonstore
timeout (int): The timeout for the http request. Default 5 seconds

client.delete(key[, timeout])

await client.delete(key[, timeout])

Delete data in jsonstore with a key

key (str): The key to get on jsonstore
timeout (int): The timeout for the http request. Default 5 seconds

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for json-store-client, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size json-store-client-1.1.0.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page