Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 59 lines (34 sloc) 1.478 kB
6076c6b @tseaver First pass.
tseaver authored
1 ``cartouche`` README
2 ====================
3
4 This package provides a set of applications which can be used to drive
5 "registration-based" sites:
6
7 - registration
8
9 - login / logout
10
11 - change password
12
13 - password recovery
14
15 - profile editing
16
17 - user / group administration
18
19
20 ``cartouche`` is built on the following components:
21
22 - The ``cartouche`` applications run atop the ``pyramid`` framework, using
23 ``chameleon`` for their templating, and ``deform`` for form schema /
24 validation handling.
25
10b710b @tseaver Add quickstart, notes on pluggability.
tseaver authored
26 - ``cartouche`` stores users, profiles, and groups in a ``ZODB`` database
27 (you can override this by registering adapters which use different
28 persistence).
6076c6b @tseaver First pass.
tseaver authored
29
30 - ``cartouche`` uses ``zope.password`` to do password hashing / checking.
31
32 - ``cartouche`` plugs into ``repoze.who`` as an authenticator, a challenger,
33 and a metadata provider.
34
10b710b @tseaver Add quickstart, notes on pluggability.
tseaver authored
35 - If your app doesn't use the ``repoze.who`` middleware, you can plug
36 ``cartouche`` in as a ``pyramid`` "authentication policy (cartouche still
37 uses the ``repoze.who`` API in this case).
38
6076c6b @tseaver First pass.
tseaver authored
39 Please see ``docs/index.rst`` for the documentation, which can also be
40 read online at:
41
42 http://packages.python.org/cartouche
10b710b @tseaver Add quickstart, notes on pluggability.
tseaver authored
43
44
45 Quick Start
46 -----------
47
48 Install into your virtualenv::
49
50 $ /path/to/virtualenv/bin/python setup.py develop
51
52 If you have a working MTA on localhost:25::
53
54 $ /path/to/venv/bin/paster serve development.ini
55
56 If you don't have working MTA on localhost:25::
57
58 $ /path/to/venv/bin/paster serve development.ini --app-name=no_mail
Something went wrong with that request. Please try again.