Skip to main content

A caching integration for Yosai

Project description

# Yosai DPCache: “DogPile” Cache Integration

![](/img/cache_bw.png)

This is a Yosai integration using a fork of the dogpile project, authored by Mike Bayer.

The dogpile project consists of two sub-projects: dogpile.core and dogpile.cache. Yosai_DPCache is a fork of these projects, replacing pickle-based serialization with serialization supported by Yosai and making a few other customizations.

## Serialization

![](/img/serialization_process.png)

Yosai reduces objects to their serializable form using the marshmallow library, encodes the “reductions” with msgpack, json, or other encoding scheme, and then caches the objects.

Objects obtained from cache are de-serialized back into their reduced forms and then re-materialized into Yosai objects.

## Installation

Install YosaiDPCache from PyPI using pip: pip install yosai_dpcache

## Setup

A YosaiDPCache.DPCacheHandler can be configured through one of two ways:

  • Option 1: YAML Config File
    1. Define a system environment variable, YOSAI_CACHE_SETTINGS, that points to the location of cache_settings.yaml file and make sure that the file permissions make it readable.
    2. Instantiate a DPCacheHandler without arguments.
  • Option 2: instantiate a DPCacheHandler, passing all of the required
    arguments (see cachehandler.py and settings.py for detail)

## Dev Status (as of YosaiDPCache v0.0.5)

### Redis is Ready for Use

Only Redis support has been implemented and ad-hoc tested.

### Unit testing is Pending

Integrated testing of yosai includes YosaiDPCache, and so YosaiDPCache is included with automated testing. However, YosaiDPCache needs its own unit tests covering its customizations.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
yosai_dpcache-0.3.0-py2.py3-none-any.whl (29.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Nov 24, 2016
yosai_dpcache-0.3.0.tar.gz (100.9 kB) Copy SHA256 hash SHA256 Source None Nov 24, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page