https://github.com/bbangert/retools

Redis Tools
https://github.com/bbangert/retools

Last synced: 3 months ago
JSON representation

Redis Tools

• Host: GitHub
• URL: https://github.com/bbangert/retools
• Owner: bbangert
• License: mit
• Created: 2011-07-01T00:33:13.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2020-12-11T18:31:54.000Z (over 3 years ago)
• Last Synced: 2024-01-16T05:55:15.945Z (5 months ago)
• Language: Python
• Homepage:
• Size: 478 KB
• Stars: 137
• Watchers: 1
• Forks: 41
• Open Issues: 10
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.txt

Lists

• awesome-redis - Retools - Caching and locking helper library. (Python) (Higher level libraries and tools)
• my-awesome-stars - bbangert/retools - Redis Tools (Python)

README

        
=====================

Redis Tools (retools)

=====================

``retools`` is a package of `Redis `_ tools. It's aim is to

provide a variety of Redis backed Python tools that are always 100% unit

tested, fast, efficient, and utilize the capabilities of Redis.

`retools` is available on PyPI at https://pypi.python.org/pypi/retools

.. image:: https://badge.fury.io/py/retools.svg

    :target: http://badge.fury.io/py/retools

Current tools in ``retools``:

* Caching

* Global Lock

* Queues - A worker/job processing system similar to `Celery

  `_ but based on how Ruby's `Resque

  `_ system works.

.. image:: https://secure.travis-ci.org/bbangert/retools.png?branch=master

   :alt: Build Status

   :target: https://secure.travis-ci.org/bbangert/retools

Caching

=======

A high performance caching system that can act as a drop-in replacement for

Beaker's caching. Unlike Beaker's caching, this utilizes Redis for distributed

write-locking dogpile prevention. It also collects hit/miss cache statistics

along with recording what regions are used by which functions and arguments.

Example:

.. code-block:: python

    from retools.cache import CacheRegion, cache_region, invalidate_function

    CacheRegion.add_region('short_term', expires=3600)

    @cache_region('short_term')

    def slow_function(*search_terms):

        # Do a bunch of work

        return results

    my_results = slow_function('bunny')

    # Invalidate the cache for 'bunny'

    invalidate_function(slow_function, [], 'bunny')

Differences from Beaker

-----------------------

Unlike Beaker's caching system, this is built strictly for Redis. As such, it

adds several features that Beaker doesn't possess:

* A distributed write-lock so that only one writer updates the cache at a time

  across a cluster.

* Hit/Miss cache statistics to give you insight into what caches are less

  effectively utilized (and may need either higher expiration times, or just

  not very worthwhile to cache).

* Very small, compact code-base with 100% unit test coverage.

Locking

=======

A Redis based lock implemented as a Python context manager, based on `Chris

Lamb's example

`_.

Example:

.. code-block:: python

    from retools.lock import Lock

    with Lock('a_key', expires=60, timeout=10):

        # do something that should only be done one at a time

License

=======

``retools`` is offered under the MIT license.

Authors

=======

``retools`` is made available by `Ben Bangert`.