Skip to content

Commit

Permalink
Logo.
Browse files Browse the repository at this point in the history
  • Loading branch information
coleifer committed Jan 8, 2015
1 parent e8eeebc commit 702a7fe
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
## Walrus

Lightweight Python utilities for working with Redis.
![](http://media.charlesleifer.com/blog/photos/p1420698394.77.jpg)

### Containers
Lightweight Python utilities for working with [Redis](http://redis.io).

Pythonic container objects for working with the primary Redis data-types:
The purpose of [walrus](https://github.com/coleifer/walrus) is to make working with Redis in Python a little easier by wrapping rich objects in Pythonic containers. walrus consists of:

* ``Hash``
* ``Set``
* ``ZSet`` (sorted set)
* ``List``
* ``Array`` (custom type)

These objects are meant to look and act like their native Python equivalents, except sorted sets, which are kind of their own thing...

### Cache

Simple cache implementation and caching decorator.
* Wrappers for the Redis object types:
* [Hash](https://walrus.readthedocs.org/en/latest/containers.html#hashes)
* [List](https://walrus.readthedocs.org/en/latest/containers.html#lists)
* [Set](https://walrus.readthedocs.org/en/latest/containers.html#sets)
* [Sorted Set](https://walrus.readthedocs.org/en/latest/containers.html#sorted-sets-zset)
* [HyperLogLog](https://walrus.readthedocs.org/en/latest/containers.html#hyperloglog)
* [Array](https://walrus.readthedocs.org/en/latest/containers.html#arrays) (custom type)
* A simple [Cache](https://walrus.readthedocs.org/en/latest/cache.html) implementation that exposes a decorator for caching function and method calls.
* Lightweight data [Model](https://walrus.readthedocs.org/en/latest/models.html) objects that support persisting structured information and performing queries using secondary indexes.

### Models

Persistent structures implemented on top of Hashes. Supports indexing to allow filtering with equality conditions.
Persistent structures implemented on top of Hashes. Supports secondary indexes to allow filtering on equality, inequality, ranges, less/greater-than, and a really basic full-text search index.
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ walrus

.. py:module:: walrus
.. image:: http://media.charlesleifer.com/blog/photos/p1420698394.77.jpg

Lightweight Python utilities for working with `Redis <http://redis.io>`_.

The purpose of `walrus <https://github.com/coleifer/walrus>`_ is to make working with Redis in Python a little easier by wrapping rich objects in Pythonic containers. walrus consists of:
Expand Down

0 comments on commit 702a7fe

Please sign in to comment.