Metadata-Version: 1.1
Name: aiohttp_session
Version: 0.1.2
Summary: sessions for aiohttp.web
Home-page: https://github.com/aio-libs/aiohttp_session/
Author: Andrew Svetlov
Author-email: andrew.svetlov@gmail.com
License: Apache 2
Description: aiohttp_session
        ===============
        
        The library provides sessions for `aiohttp.web`__.
        
        .. _aiohttp_web: http://aiohttp.readthedocs.org/en/latest/web.html
        
        __ aiohttp_web_
        
        Usage
        -----
        
        The library allows to store user-specific data into session object.
        
        The session object has dict-like interface (operations like
        ``session[key] = value``, ``value = session[key]`` etc. are present).
        
        
        Before processing session in web-handler you have to register *session
        middleware* in ``aiohttp.web.Application``.
        
        A trivial usage example::
        
            import asyncio
            import time
            from aiohttp import web
            from aiohttp_session import get_session, session_middleware
            from aiohttp_session.cookie_storage import EncryptedCookieStorage
        
            @asyncio.coroutine
            def handler(request):
                session = yield from get_session(request)
                session['last_visit'] = time.time()
                return web.Response(body=b'OK')
        
            @asyncio.coroutine
            def init(loop):
                app = web.Application(middlewares=[session_middleware(
                    EncryptedCookieStorage(b'Sixteen byte key'))])
                app.router.add_route('GET', '/', handler)
                srv = yield from loop.create_server(
                    app.make_handler(), '0.0.0.0', 8080)
                return srv
        
            loop = asyncio.get_event_loop()
            loop.run_until_complete(init(loop))
            try:
                loop.run_forever()
            except KeyboardInterrupt:
                pass
        
        All storages uses HTTP Cookie named ``AIOHTTP_COOKIE_SESSION`` for storing data.
        
        Available session storages are:
        
        * ``aiohttp_session.SimpleCookieStorage()`` -- keeps session data as
          plain JSON string in cookie body. Use the storage only for testing
          purposes, it's very non-secure.
        
        * ``aiohttp_session.cookie_storage.EncryptedCookieStorage(secret_key)``
          -- stores session data into cookies as ``SimpleCookieStorage`` but
          encodes it via AES cipher. ``secrect_key`` is a ``bytes`` key for AES
          encryption/decryption, the length should be 16 bytes.
        
          Requires ``PyCrypto`` library::
        
              $ pip install aiohttp_session[pycrypto]
        
        * ``aiohttp_session.redis_storage.RedisStorage(redis_pool)`` -- stores
          JSON-ed data into *redis*, keepeng into cookie only redis key
          (random UUID). ``redis_pool`` is ``aioredis`` pool object, created by
          ``yield from aioredis.create_pool(...)`` call.
        
          Requires ``aioredis`` library::
        
              $ pip install aiohttp_session[aioredis]
        
        License
        -------
        
        ``aiohttp_session`` is offered under the Apache 2 license.
        
        Changes
        =======
        
        0.1.1 (2015-04-20)
        ------------------
        
        - Fix #7: stop cookie name growing each time session is saved
        
        
        0.1.0 (2015-04-13)
        ------------------
        
        - First public release
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Internet :: WWW/HTTP
