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.

Source Distribution

json-store-client-1.1.0.tar.gz (3.8 kB view details)

Uploaded Source

File details

Details for the file json-store-client-1.1.0.tar.gz.

File metadata

  • Download URL: json-store-client-1.1.0.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.4

File hashes

Hashes for json-store-client-1.1.0.tar.gz
Algorithm Hash digest
SHA256 83078d7e85721cfc2d13bef9ffdab37a8214acb5680cc4c094b236846e9910ed
MD5 748c1b41b6c0511f916ff88ef12baa6b
BLAKE2b-256 0d43a3fcdaf9db4f451fa7ab4c8fa6749e36612530d2e6feaa56a22e780c9668

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page