Metadata-Version: 2.0
Name: rebecca.login
Version: 0.1
Summary: UNKNOWN
Home-page: https://github.com/rebeccaframework/rebecca.login
Author: Atsushi Odagiri
Author-email: aodagx@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Framework :: Pyramid
Requires-Dist: pyramid
Requires-Dist: rebecca.repository
Requires-Dist: setuptools (>=0.7)
Provides-Extra: testing
Requires-Dist: testfixtures; extra == 'testing'

rebecca.login
===========================

.. image:: https://travis-ci.org/rebeccaframework/rebecca.login.png
   :target: https://travis-ci.org/rebeccaframework/rebecca.login

INSTALL
------------------------

::

  $ pip install rebecca.login


USAGE
----------------------------

``rebecca.login`` provides ``login`` and ``logout`` functions.
``login`` requires ``rebecca.repository.interfaces.IRepository`` named ``users``.

``login`` returns authenticated headers.

example::

    def login_success(self, values):
        user_name = values['user_name']
        password = values['password']
        authenticated = login(self.request, user_name, password)
        if not authenticated:
            return
        headers = security.remember(self.request, authenticated)
        response = HTTPFound(self.request.route_url('top'))
        response.headerlist.extend(headers)
        return response

Changes
=====================

0.1 (2013-11-16)
---------------------

- first release


