Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 52 lines (35 sloc) 2.018 kb
82ce03f @paltman added a start to documentation
paltman authored
1 ==========
2 privileges
3 ==========
b3c21de @paltman initial commit
paltman authored
4
41304b8 @paltman Update README.rst
paltman authored
5 .. image:: https://img.shields.io/travis/eldarion/privileges.svg
6 :target: https://travis-ci.org/eldarion/privileges
7
8 .. image:: https://img.shields.io/coveralls/eldarion/privileges.svg
9 :target: https://coveralls.io/r/eldarion/privileges
10
11 .. image:: https://img.shields.io/pypi/dm/privileges.svg
12 :target: https://pypi.python.org/pypi/privileges/
13
14 .. image:: https://img.shields.io/pypi/v/privileges.svg
15 :target: https://pypi.python.org/pypi/privileges/
16
17 .. image:: https://img.shields.io/badge/license-BSD-blue.svg
18 :target: https://pypi.python.org/pypi/privileges/
19
20
de0a4af @paltman providing a one-liner for explaining privileges
paltman authored
21 ``privileges`` makes segmenting authenticated users easy and extensible.
82ce03f @paltman added a start to documentation
paltman authored
22
747dd39 @jtauber whitespace
jtauber authored
23 Unlike Django permissions, ``privileges`` is not tied to operations on
82ce03f @paltman added a start to documentation
paltman authored
24 individual models. It operates at a higher level of abstraction and is instead
25 concerned more with providing the site developer complete freedom in determining
26 who can do what. There certainly is some overlap with the built in permissions
27 system, and while you could use ``privileges`` to replace it, at least large
28 parts of it, that is not the aim of this app.
29
30 Instead, think of ``privileges`` allowing the site developer to control
31 access to certain features. Operating at the template and view layers the site
32 developer can paint as broad or as fine of strokes to suit their needs.
33
34 It is extensible in the sense that the site developer can define and register
35 their own privilege validation handlers. In fact they must define at least one
36 handler. There is a template tag for checking privileges in templates and a
37 decorator for checking privileges when a view is called.
38
39 There is a model that stores the named privileges which are nothing more than
40 named slugs. The records carry no special meeting to ``privileges`` in isolation
41 but depend on the site developer to impart meaning through reference in his
42 site.
72971e0 @paltman Add sponsorship attribution to Midwest Communications
paltman authored
43
44
45 Sponsorship
46 -----------
47
48 development sponsored by `Midwest Communications`_
49
50
41304b8 @paltman Update README.rst
paltman authored
51 .. _`Midwest Communications`: http://mwcradio.com/
Something went wrong with that request. Please try again.