README.rst

KBase Cache Server Python Client

This is a python client for the file cache service offered by KBase.

Documentation for the KBase file cache server can be found here: https://github.com/kbase/CachingService

Installation

Install via pip using the KBase anaconda repository:

pip install --extra-index-url https://pypi.anaconda.org/kbase/simple kbase_cache_client

Usage

Create the client:

cache_client = KBaseCacheClient('https://appdev.kbase.us/services/', token='xyz')

Where token is a KBase developer or service token. This can also be left out and set as the KBASE_CACHE_TOKEN environment variable.

Generate a cache ID:

cacheid = cache_client.generate_cacheid({'test': 'this is a test identifier to id a cache file'})

Upload a file to a cache ID:

# Upload file contents using a file path:
cache_client.upload_cache(cacheid, path=my_file)
# Upload a string as the cache contents
cache_client.upload_cache(cacheid, string='hello world')

Download a cached file:

cache_client.download_cache(cacheid, destination_path)

Delete a cached file:

cache_client.delete_cache(cacheid)

Development

First, activate a virtual environment with:

python -m venv env
source env/bin/activate

Run tests with make test

Publishing

To build the pip package, first run make build

Publish the package to anaconda under the kbase org:

anaconda upload -i -u kbase dist/kbase_cache_client-{version}.tar.gz