Skip to content
Browse files

README -> readme.md

  • Loading branch information...
1 parent f409b75 commit 595308d5212478621c0214f1087f6dede80e082d Simon Zimmermann committed Jan 14, 2012
Showing with 32 additions and 0 deletions.
  1. +32 −0 readme.md
View
32 readme.md
@@ -0,0 +1,32 @@
+# odis
+
+odis - objects in [Redis](http://redis.io) for Python.
+
+## Install odis
+
+ $ pip install git+git://github.com/simonz05/odis.git
+
+## Use odis
+
+ from odis import Model, CharField, DateTimeField
+
+ class Foo(Model):
+ username = CharField(index=True, unique=True)
+ created_at = DateTimeField(aut_now_add=True)
+
+
+ >>> obj = Foo(username='foo')
+ >>> obj.save()
+ True
+
+ >>> Foo.obj.get(username='foo')
+ <Foo {'username': 'foo', 'pk': 1, 'created_at': datetime.datetime(2012, 1, 14, 0, 0)}>
+
+ >>> Foo.obj.filter(username='foo')
+ <odis.QuerySet at 0x24e50d0>
+
+## Acknowledgment
+
+[Ohm](http://ohm.keyvalue.org/), [redisco](https://github.com/iamteem/redisco/) and
+[Django internals](https://github.com/django/django/tree/master/django/db/models)
+were used to figure out how to solve similar problems.

0 comments on commit 595308d

Please sign in to comment.
Something went wrong with that request. Please try again.