Permalink
Browse files

Update README.markdown

  • Loading branch information...
1 parent d621e1a commit d20983fb21458976cf5e8d3146b2aab2295f4b8b @diogobaeder committed Oct 29, 2011
Showing with 47 additions and 19 deletions.
  1. +47 −19 README.markdown
View
@@ -1,18 +1,22 @@
# pycket
-This is a session library, written for use with Redis and Tornado web server.
+This is a session library, written for use with Redis or Memcached, and Tornado web server.
## License
This software is under BSD 2-Clause License (see LICENSE file)
## Requirements
Non-Python requirements:
-* Redis (tested with version 2.4.0)
+* Redis (tested with version 2.4.0) or Memcached (tested with version 1.4.7)
Python requirements (included in setup script)
-* [Tornado](http://pypi.python.org/pypi/tornado) (tested with 2.1.1, installable via "tornado" package in PyPI)
+* [Tornado](http://pypi.python.org/pypi/tornado/) (tested with 2.1.1, installable via "tornado" package in PyPI)
+
+Python requirements (not included, because depend on the datastore that you wish to use)
+
* [redis-py](http://pypi.python.org/pypi/redis/) (tested with 2.4.9, installable via "redis" package in PyPI)
+* [python-memcached](http://pypi.python.org/pypi/python-memcached/) (tested with 1.47, installable via "python-memcached" package in PyPI)
## Installing
If you use virtualenv:
@@ -43,7 +47,7 @@ $ python setup.py install
If you wish to contribute to the project as a developer, just install the requirements file included in the project with pip.
## Examples
-You have two ways of using pycket sessions in your application.
+You have two ways of using pycket sessions in your application (please refer to the "Settings" section below before starting to use).
The easier way is including the appropriate mixin(s) in the handler's inheritance list, and the "session" member will become available:
@@ -88,35 +92,59 @@ print session['gimme'] # 'Fire!'
## Settings
pycket understands two types of settings, which must be items in the application's settings:
-1. "pycket_redis": this is a dictionary containing any items that should be repassed to the redis.Redis instance to be used in the session manager (such as "host" and "port"); Notice, however, that if you want to change the dataset numbers to be used for sessions and notifications, use "db_sessions" and "db_notifications", respectively, instead of "db" (they will be converted to the "db" parameter that is passed to the Redis client for each manager afterwards);
-2. "pycket_cookies": this is a dictionary containing all settings to be repassed to the RequestHandler.set_secure_cookie. If they don't contain "expires" or "expires_days" items, they will be set as None, which means that the default behaviour for the sessions is to last on browser session. (And deleted as soon as the user closes the browser.) Notice that the sessions in the database last for one day, though.
+1. ["pycket"]: the base settings dictionary for pycket;
+2. ["pycket"]["engine"]: the only mandatory setting. Must be "redis" or "memcached";
+1. ["pycket"]["storage"]: this is a dictionary containing any items that should be repassed to the redis.Redis or memcached.Client to be used in the session manager (such as "host", "port", "servers" etc); Notice that for Redis, however, that if you want to change the dataset numbers to be used for sessions and notifications, use "db_sessions" and "db_notifications", respectively, instead of "db" (they will be converted to the "db" parameter that is passed to the Redis client for each manager afterwards);
+2. ["pycket"]["cookies"]: this is a dictionary containing all settings to be repassed to the RequestHandler.set_secure_cookie. If they don't contain "expires" or "expires_days" items, they will be set as None, which means that the default behaviour for the sessions is to last on browser session. (And deleted as soon as the user closes the browser.) Notice that the sessions in the database last for one day, though.
+
+Example using Redis:
+
+```python
+application = tornado.web.Application([
+ (r'/', MainHandler),
+], **{
+ 'pycket': {
+ 'engine': 'redis',
+ 'storage': {
+ 'host': 'localhost',
+ 'port': 6379,
+ 'db_sessions': 10,
+ 'db_notifications': 11,
+ },
+ 'cookies': {
+ 'expires_days': 120,
+ },
+ },
+)
+```
-Example:
+Example using Memcached:
```python
application = tornado.web.Application([
(r'/', MainHandler),
], **{
- 'pycket_redis': {
- 'host': 'localhost',
- 'port': 6379,
- 'db_sessions': 10,
- 'db_notifications': 11,
- }
- 'pycket_cookies': {
- 'expires_days': 120,
- }
+ 'pycket': {
+ 'engine': 'memcached',
+ 'storage': {
+ 'servers': ('localhost:11211',)
+ },
+ 'cookies': {
+ 'expires_days': 120,
+ },
+ },
)
```
-The default dataset numbers for sessions and notifications are, respectively, 0 and 1.
+The default Redis dataset numbers for sessions and notifications are, respectively, 0 and 1, and the default Memcached servers tuple is ("localhost:11211",)
## Notifications
This feature is almost equal to the sessions, but slightly different:
* They have to be used via pycket.notification.NotificationMixin or pycket.notification.NotificationManager;
-* The values persisted with them can be retrieved only once, and after this are immediately deleted from the dataset;
-* The default dataset used is 1, instead of 0, to avoid conflicts with normal sessions.
+* The values persisted with them can be retrieved only once, and after this are immediately deleted from the datastore;
+* The default Redis dataset used is 1, instead of 0, to avoid conflicts with normal sessions.
+* Unfortunately, for Memcached, the notifications are saved in the same datastore as the sessions, because I still didn't find a way keep them in a separate datastore.
## Author
This module was developed by Diogo Baeder (*/diogobaeder), who is an absolute Python lover, and is currently in love with event-driven programming and ArchLinux.

0 comments on commit d20983f

Please sign in to comment.