pyramid-fullauth 0.0.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. pyramid_fullauth-0.0.2/CHANGES.rst +12 -0
  2. pyramid_fullauth-0.0.2/MANIFEST.in +5 -0
  3. pyramid_fullauth-0.0.2/PKG-INFO +71 -0
  4. pyramid_fullauth-0.0.2/README.rst +35 -0
  5. pyramid_fullauth-0.0.2/docs/Makefile +153 -0
  6. pyramid_fullauth-0.0.2/docs/make.bat +190 -0
  7. pyramid_fullauth-0.0.2/docs/source/advanced.rst +62 -0
  8. pyramid_fullauth-0.0.2/docs/source/api/auth.rst +7 -0
  9. pyramid_fullauth-0.0.2/docs/source/api/events.rst +58 -0
  10. pyramid_fullauth-0.0.2/docs/source/api/models.rst +32 -0
  11. pyramid_fullauth-0.0.2/docs/source/api/request.rst +5 -0
  12. pyramid_fullauth-0.0.2/docs/source/api/tools.rst +6 -0
  13. pyramid_fullauth-0.0.2/docs/source/api.rst +13 -0
  14. pyramid_fullauth-0.0.2/docs/source/basic.rst +70 -0
  15. pyramid_fullauth-0.0.2/docs/source/conf.py +309 -0
  16. pyramid_fullauth-0.0.2/docs/source/customise.rst +23 -0
  17. pyramid_fullauth-0.0.2/docs/source/index.rst +40 -0
  18. pyramid_fullauth-0.0.2/docs/source/narrative.rst +14 -0
  19. pyramid_fullauth-0.0.2/docs/source/social.rst +44 -0
  20. pyramid_fullauth-0.0.2/pyramid_fullauth/__init__.py +72 -0
  21. pyramid_fullauth-0.0.2/pyramid_fullauth/auth.py +88 -0
  22. pyramid_fullauth-0.0.2/pyramid_fullauth/config/config.yml +15 -0
  23. pyramid_fullauth-0.0.2/pyramid_fullauth/events.py +245 -0
  24. pyramid_fullauth-0.0.2/pyramid_fullauth/exceptions.py +9 -0
  25. pyramid_fullauth-0.0.2/pyramid_fullauth/models/__init__.py +227 -0
  26. pyramid_fullauth-0.0.2/pyramid_fullauth/models/mixins.py +137 -0
  27. pyramid_fullauth-0.0.2/pyramid_fullauth/request.py +59 -0
  28. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/helpers/social.mako +9 -0
  29. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/templates/403.mako +4 -0
  30. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/templates/_form.login.mako +37 -0
  31. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/templates/_form.register.mako +40 -0
  32. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/templates/_social.login.mako +10 -0
  33. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/templates/activate.mako +3 -0
  34. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/templates/email_change.mako +26 -0
  35. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/templates/layout.mako +6 -0
  36. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/templates/login.mako +7 -0
  37. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/templates/register.mako +21 -0
  38. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/templates/reset.mako +27 -0
  39. pyramid_fullauth-0.0.2/pyramid_fullauth/resources/templates/reset.proceed.mako +34 -0
  40. pyramid_fullauth-0.0.2/pyramid_fullauth/routing/__init__.py +1 -0
  41. pyramid_fullauth-0.0.2/pyramid_fullauth/routing/predicates.py +60 -0
  42. pyramid_fullauth-0.0.2/pyramid_fullauth/tools.py +18 -0
  43. pyramid_fullauth-0.0.2/pyramid_fullauth/views/__init__.py +11 -0
  44. pyramid_fullauth-0.0.2/pyramid_fullauth/views/basic/__init__.py +2 -0
  45. pyramid_fullauth-0.0.2/pyramid_fullauth/views/basic/forbidden.py +40 -0
  46. pyramid_fullauth-0.0.2/pyramid_fullauth/views/basic/login.py +117 -0
  47. pyramid_fullauth-0.0.2/pyramid_fullauth/views/basic/profile.py +177 -0
  48. pyramid_fullauth-0.0.2/pyramid_fullauth/views/basic/register.py +145 -0
  49. pyramid_fullauth-0.0.2/pyramid_fullauth/views/social.py +133 -0
  50. pyramid_fullauth-0.0.2/pyramid_fullauth.egg-info/PKG-INFO +71 -0
  51. pyramid_fullauth-0.0.2/pyramid_fullauth.egg-info/SOURCES.txt +65 -0
  52. pyramid_fullauth-0.0.2/pyramid_fullauth.egg-info/dependency_links.txt +1 -0
  53. pyramid_fullauth-0.0.2/pyramid_fullauth.egg-info/not-zip-safe +1 -0
  54. pyramid_fullauth-0.0.2/pyramid_fullauth.egg-info/requires.txt +15 -0
  55. pyramid_fullauth-0.0.2/pyramid_fullauth.egg-info/top_level.txt +2 -0
  56. pyramid_fullauth-0.0.2/setup.cfg +9 -0
  57. pyramid_fullauth-0.0.2/setup.py +68 -0
  58. pyramid_fullauth-0.0.2/tests/__init__.py +130 -0
  59. pyramid_fullauth-0.0.2/tests/config/config.np.yml +4 -0
  60. pyramid_fullauth-0.0.2/tests/config/config.pc.yml +5 -0
  61. pyramid_fullauth-0.0.2/tests/config/config.yml +14 -0
  62. pyramid_fullauth-0.0.2/tests/test_email.py +88 -0
  63. pyramid_fullauth-0.0.2/tests/test_login.py +339 -0
  64. pyramid_fullauth-0.0.2/tests/test_models.py +463 -0
  65. pyramid_fullauth-0.0.2/tests/test_register.py +326 -0
  66. pyramid_fullauth-0.0.2/tests/test_reset.py +104 -0
@@ -0,0 +1,12 @@
1
+ =======
2
+ CHANGES
3
+ =======
4
+
5
+ 0.0.2
6
+ -----
7
+ - fixed MANIFEST.in, to include .yml, and .mako files
8
+
9
+ 0.0.1
10
+ -----
11
+ - initial package creation
12
+ - prepared for CI on travis-ci, and coverage reports on coveralls.io
@@ -0,0 +1,5 @@
1
+ include *.rst *.py
2
+ recursive-include pyramid_fullauth *.py *.yml *.mako
3
+ recursive-include docs *
4
+ prune docs/build
5
+ recursive-include tests *.py *.yml
@@ -0,0 +1,71 @@
1
+ Metadata-Version: 1.1
2
+ Name: pyramid_fullauth
3
+ Version: 0.0.2
4
+ Summary: This package intends to provide full authentication / authorisation
5
+ implementation for pyramid applications
6
+ Home-page: https://github.com/fizyk/pyramid_fullauth
7
+ Author: Grzegorz Sliwinski
8
+ Author-email: username: fizyk, domain: fizyk.net.pl
9
+ License: UNKNOWN
10
+ Description: pyramid_fullauth
11
+ ================
12
+
13
+ .. image:: https://travis-ci.org/fizyk/pyramid_fullauth.png?branch=master
14
+ :target: https://travis-ci.org/fizyk/pyramid_fullauth
15
+ :alt: Tests for RandomWords
16
+
17
+ .. image:: https://coveralls.io/repos/fizyk/pyramid_fullauth/badge.png?branch=master
18
+ :target: https://coveralls.io/r/fizyk/pyramid_fullauth?branch=master
19
+ :alt: Coverage Status
20
+
21
+ .. image:: https://pypip.in/v/pyramid_fullauth/badge.png
22
+ :target: https://crate.io/packages/pyramid_fullauth/
23
+ :alt: Latest PyPI version
24
+
25
+ .. image:: https://pypip.in/d/pyramid_fullauth/badge.png
26
+ :target: https://crate.io/packages/pyramid_fullauth/
27
+ :alt: Number of PyPI downloads
28
+
29
+ Pyramid fullauth's goal is to provide full plug-in registration functionality for pyramid, with user managing
30
+
31
+ Instalation:
32
+ ============
33
+
34
+ ``pip install pyramid_fullauth``
35
+
36
+ or add **pyramid_fullauth* to your **setup.py** requirements.
37
+
38
+
39
+ Tests:
40
+ ======
41
+
42
+ You'll need: **nose**, **WebTest**, **coverage** to run tests, and then:
43
+
44
+ ``python setup.py nosetests``
45
+
46
+
47
+ =======
48
+ CHANGES
49
+ =======
50
+
51
+ 0.0.2
52
+ -----
53
+ - fixed MANIFEST.in, to include .yml, and .mako files
54
+
55
+ 0.0.1
56
+ -----
57
+ - initial package creation
58
+ - prepared for CI on travis-ci, and coverage reports on coveralls.io
59
+
60
+ Keywords: python authentication authorisation pyramid
61
+ Platform: UNKNOWN
62
+ Classifier: Development Status :: 5 - Production/Stable
63
+ Classifier: Environment :: Web Environment
64
+ Classifier: Intended Audience :: Developers
65
+ Classifier: License :: Public Domain
66
+ Classifier: Natural Language :: English
67
+ Classifier: Operating System :: OS Independent
68
+ Classifier: Programming Language :: Python
69
+ Classifier: Programming Language :: Python :: 2.6
70
+ Classifier: Programming Language :: Python :: 2.7
71
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -0,0 +1,35 @@
1
+ pyramid_fullauth
2
+ ================
3
+
4
+ .. image:: https://travis-ci.org/fizyk/pyramid_fullauth.png?branch=master
5
+ :target: https://travis-ci.org/fizyk/pyramid_fullauth
6
+ :alt: Tests for RandomWords
7
+
8
+ .. image:: https://coveralls.io/repos/fizyk/pyramid_fullauth/badge.png?branch=master
9
+ :target: https://coveralls.io/r/fizyk/pyramid_fullauth?branch=master
10
+ :alt: Coverage Status
11
+
12
+ .. image:: https://pypip.in/v/pyramid_fullauth/badge.png
13
+ :target: https://crate.io/packages/pyramid_fullauth/
14
+ :alt: Latest PyPI version
15
+
16
+ .. image:: https://pypip.in/d/pyramid_fullauth/badge.png
17
+ :target: https://crate.io/packages/pyramid_fullauth/
18
+ :alt: Number of PyPI downloads
19
+
20
+ Pyramid fullauth's goal is to provide full plug-in registration functionality for pyramid, with user managing
21
+
22
+ Instalation:
23
+ ============
24
+
25
+ ``pip install pyramid_fullauth``
26
+
27
+ or add **pyramid_fullauth* to your **setup.py** requirements.
28
+
29
+
30
+ Tests:
31
+ ======
32
+
33
+ You'll need: **nose**, **WebTest**, **coverage** to run tests, and then:
34
+
35
+ ``python setup.py nosetests``
@@ -0,0 +1,153 @@
1
+ # Makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line.
5
+ SPHINXOPTS =
6
+ SPHINXBUILD = sphinx-build
7
+ PAPER =
8
+ BUILDDIR = build
9
+
10
+ # Internal variables.
11
+ PAPEROPT_a4 = -D latex_paper_size=a4
12
+ PAPEROPT_letter = -D latex_paper_size=letter
13
+ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14
+ # the i18n builder cannot share the environment and doctrees with the others
15
+ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
16
+
17
+ .PHONY: help clean html html_venv dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18
+
19
+ help:
20
+ @echo "Please use \`make <target>' where <target> is one of"
21
+ @echo " html to make standalone HTML files"
22
+ @echo " dirhtml to make HTML files named index.html in directories"
23
+ @echo " singlehtml to make a single large HTML file"
24
+ @echo " pickle to make pickle files"
25
+ @echo " json to make JSON files"
26
+ @echo " htmlhelp to make HTML files and a HTML help project"
27
+ @echo " qthelp to make HTML files and a qthelp project"
28
+ @echo " devhelp to make HTML files and a Devhelp project"
29
+ @echo " epub to make an epub"
30
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
32
+ @echo " text to make text files"
33
+ @echo " man to make manual pages"
34
+ @echo " texinfo to make Texinfo files"
35
+ @echo " info to make Texinfo files and run them through makeinfo"
36
+ @echo " gettext to make PO message catalogs"
37
+ @echo " changes to make an overview of all changed/added/deprecated items"
38
+ @echo " linkcheck to check all external links for integrity"
39
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
40
+
41
+ clean:
42
+ -rm -rf $(BUILDDIR)/*
43
+
44
+ html:
45
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46
+ @echo
47
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48
+
49
+ dirhtml:
50
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
51
+ @echo
52
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
53
+
54
+ singlehtml:
55
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
56
+ @echo
57
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
58
+
59
+ pickle:
60
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
61
+ @echo
62
+ @echo "Build finished; now you can process the pickle files."
63
+
64
+ json:
65
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
66
+ @echo
67
+ @echo "Build finished; now you can process the JSON files."
68
+
69
+ htmlhelp:
70
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
71
+ @echo
72
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
73
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
74
+
75
+ qthelp:
76
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
77
+ @echo
78
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
79
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
80
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Subscribepyramidplugin.qhcp"
81
+ @echo "To view the help file:"
82
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Subscribepyramidplugin.qhc"
83
+
84
+ devhelp:
85
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
86
+ @echo
87
+ @echo "Build finished."
88
+ @echo "To view the help file:"
89
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/Subscribepyramidplugin"
90
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Subscribepyramidplugin"
91
+ @echo "# devhelp"
92
+
93
+ epub:
94
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
95
+ @echo
96
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
97
+
98
+ latex:
99
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100
+ @echo
101
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
103
+ "(use \`make latexpdf' here to do that automatically)."
104
+
105
+ latexpdf:
106
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107
+ @echo "Running LaTeX files through pdflatex..."
108
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
109
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110
+
111
+ text:
112
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113
+ @echo
114
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
115
+
116
+ man:
117
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118
+ @echo
119
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120
+
121
+ texinfo:
122
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123
+ @echo
124
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125
+ @echo "Run \`make' in that directory to run these through makeinfo" \
126
+ "(use \`make info' here to do that automatically)."
127
+
128
+ info:
129
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130
+ @echo "Running Texinfo files through makeinfo..."
131
+ make -C $(BUILDDIR)/texinfo info
132
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133
+
134
+ gettext:
135
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136
+ @echo
137
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138
+
139
+ changes:
140
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141
+ @echo
142
+ @echo "The overview file is in $(BUILDDIR)/changes."
143
+
144
+ linkcheck:
145
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146
+ @echo
147
+ @echo "Link check complete; look for any errors in the above output " \
148
+ "or in $(BUILDDIR)/linkcheck/output.txt."
149
+
150
+ doctest:
151
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152
+ @echo "Testing of doctests in the sources finished, look at the " \
153
+ "results in $(BUILDDIR)/doctest/output.txt."
@@ -0,0 +1,190 @@
1
+ @ECHO OFF
2
+
3
+ REM Command file for Sphinx documentation
4
+
5
+ if "%SPHINXBUILD%" == "" (
6
+ set SPHINXBUILD=sphinx-build
7
+ )
8
+ set BUILDDIR=build
9
+ set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
10
+ set I18NSPHINXOPTS=%SPHINXOPTS% source
11
+ if NOT "%PAPER%" == "" (
12
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14
+ )
15
+
16
+ if "%1" == "" goto help
17
+
18
+ if "%1" == "help" (
19
+ :help
20
+ echo.Please use `make ^<target^>` where ^<target^> is one of
21
+ echo. html to make standalone HTML files
22
+ echo. dirhtml to make HTML files named index.html in directories
23
+ echo. singlehtml to make a single large HTML file
24
+ echo. pickle to make pickle files
25
+ echo. json to make JSON files
26
+ echo. htmlhelp to make HTML files and a HTML help project
27
+ echo. qthelp to make HTML files and a qthelp project
28
+ echo. devhelp to make HTML files and a Devhelp project
29
+ echo. epub to make an epub
30
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
31
+ echo. text to make text files
32
+ echo. man to make manual pages
33
+ echo. texinfo to make Texinfo files
34
+ echo. gettext to make PO message catalogs
35
+ echo. changes to make an overview over all changed/added/deprecated items
36
+ echo. linkcheck to check all external links for integrity
37
+ echo. doctest to run all doctests embedded in the documentation if enabled
38
+ goto end
39
+ )
40
+
41
+ if "%1" == "clean" (
42
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
43
+ del /q /s %BUILDDIR%\*
44
+ goto end
45
+ )
46
+
47
+ if "%1" == "html" (
48
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
49
+ if errorlevel 1 exit /b 1
50
+ echo.
51
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
52
+ goto end
53
+ )
54
+
55
+ if "%1" == "dirhtml" (
56
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
57
+ if errorlevel 1 exit /b 1
58
+ echo.
59
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
60
+ goto end
61
+ )
62
+
63
+ if "%1" == "singlehtml" (
64
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
65
+ if errorlevel 1 exit /b 1
66
+ echo.
67
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
68
+ goto end
69
+ )
70
+
71
+ if "%1" == "pickle" (
72
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
73
+ if errorlevel 1 exit /b 1
74
+ echo.
75
+ echo.Build finished; now you can process the pickle files.
76
+ goto end
77
+ )
78
+
79
+ if "%1" == "json" (
80
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
81
+ if errorlevel 1 exit /b 1
82
+ echo.
83
+ echo.Build finished; now you can process the JSON files.
84
+ goto end
85
+ )
86
+
87
+ if "%1" == "htmlhelp" (
88
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
89
+ if errorlevel 1 exit /b 1
90
+ echo.
91
+ echo.Build finished; now you can run HTML Help Workshop with the ^
92
+ .hhp project file in %BUILDDIR%/htmlhelp.
93
+ goto end
94
+ )
95
+
96
+ if "%1" == "qthelp" (
97
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
98
+ if errorlevel 1 exit /b 1
99
+ echo.
100
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
101
+ .qhcp project file in %BUILDDIR%/qthelp, like this:
102
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Subscribepyramidplugin.qhcp
103
+ echo.To view the help file:
104
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Subscribepyramidplugin.ghc
105
+ goto end
106
+ )
107
+
108
+ if "%1" == "devhelp" (
109
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
110
+ if errorlevel 1 exit /b 1
111
+ echo.
112
+ echo.Build finished.
113
+ goto end
114
+ )
115
+
116
+ if "%1" == "epub" (
117
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
118
+ if errorlevel 1 exit /b 1
119
+ echo.
120
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
121
+ goto end
122
+ )
123
+
124
+ if "%1" == "latex" (
125
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
126
+ if errorlevel 1 exit /b 1
127
+ echo.
128
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
129
+ goto end
130
+ )
131
+
132
+ if "%1" == "text" (
133
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
134
+ if errorlevel 1 exit /b 1
135
+ echo.
136
+ echo.Build finished. The text files are in %BUILDDIR%/text.
137
+ goto end
138
+ )
139
+
140
+ if "%1" == "man" (
141
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
142
+ if errorlevel 1 exit /b 1
143
+ echo.
144
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
145
+ goto end
146
+ )
147
+
148
+ if "%1" == "texinfo" (
149
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
150
+ if errorlevel 1 exit /b 1
151
+ echo.
152
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
153
+ goto end
154
+ )
155
+
156
+ if "%1" == "gettext" (
157
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
158
+ if errorlevel 1 exit /b 1
159
+ echo.
160
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
161
+ goto end
162
+ )
163
+
164
+ if "%1" == "changes" (
165
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
166
+ if errorlevel 1 exit /b 1
167
+ echo.
168
+ echo.The overview file is in %BUILDDIR%/changes.
169
+ goto end
170
+ )
171
+
172
+ if "%1" == "linkcheck" (
173
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
174
+ if errorlevel 1 exit /b 1
175
+ echo.
176
+ echo.Link check complete; look for any errors in the above output ^
177
+ or in %BUILDDIR%/linkcheck/output.txt.
178
+ goto end
179
+ )
180
+
181
+ if "%1" == "doctest" (
182
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
183
+ if errorlevel 1 exit /b 1
184
+ echo.
185
+ echo.Testing of doctests in the sources finished, look at the ^
186
+ results in %BUILDDIR%/doctest/output.txt.
187
+ goto end
188
+ )
189
+
190
+ :end
@@ -0,0 +1,62 @@
1
+ Advanced configuration
2
+ ======================
3
+
4
+ Authentication policy
5
+ ---------------------
6
+
7
+ registerlogin uses **AuthTktAuthenticationPolicy**. It's default settings are stored within config as:
8
+
9
+
10
+ .. code-block:: yaml
11
+
12
+ registerlogin:
13
+ AuthTkt:
14
+ secret: fullauth_psst # default secret used to hash auth_tk cookie
15
+ hashalg: sha512 # default authentication policy hash algorithm
16
+ timeout: 2 # (optional) number of seconds for which an auth ticket will be valid
17
+ reissue_time: 0.2 # (optional) number of seconds that must pass before an authentication token cookie is automatically reissued as the result of a request which requires authentication
18
+
19
+ .. note::
20
+
21
+ **timeout** and **reissue_time** settings indicate after which period of time user will be logged out in case of inactivity. If not included in your AuthTktAuthenticationPolicy config, default value for them will be None.
22
+ To get a better insight on how they work when they are set, look at **tests.test_login**: **test_automatic_logout** and **test_automatic_logout_not_expired** test cases.
23
+
24
+ .. seealso::
25
+ For more information about additional settings that could be included in your AuthTktAuthenticationPolicy
26
+ as well as how to set optimal values for timeout and reissue_time please see http://pyramid.readthedocs.org/en/latest/api/authentication.html#pyramid.authentication.AuthTktAuthenticationPolicy.
27
+
28
+ .. warning::
29
+ **callback** setting is already defined by registerlogin as :meth:`pyramid_fullauth.auth.groupfinder`.
30
+
31
+ .. note::
32
+
33
+ To restrict subdomain applications from using the same cookie, use **registerlogin.AuthTkt.wild_domain setting**, and set it to False.
34
+ This will restrict emitted cookies to current domain only.
35
+ You can also change settings as **registerlogin.AuthTkt.cookie_name** and **registerlogin.AuthTkt.secret** to make sure, your apps will use different cookie names and salts.
36
+
37
+
38
+ Authentication Providers
39
+ ------------------------
40
+
41
+ Might happen, that the project needs to identify what authentication providers is user using (Might use e.g facebook, google, email, some OpenID). That's what the user.providers relation is for.
42
+
43
+ It stores data needed to authenticate with different providers for each user, but the exception is email, where user is identified by id in a system. Each of the social providers entry gets added by connecting user account with given social network, and the email entry during standard registration or during reset password.
44
+
45
+
46
+ ACL
47
+ ---
48
+
49
+ ``pyramid_fullauth`` package provides also a basic ACL Mixin for your RootFactory. it contains basic acl definition as well as init method.
50
+
51
+ See :class:`pyramid_fullauth.auth.BaseACLRootFactoryMixin`
52
+
53
+
54
+ Events
55
+ ------
56
+
57
+ Plugin emits several events throughout the registration process, login and several other actions.
58
+
59
+ All of them, along with details description can be found in the :mod:`pyramid_fullauth.events` package.
60
+
61
+ Read the http://pyramid.readthedocs.org/en/latest/api/events.html to see how to
62
+ add an event subscriber to Your application and handle those events.
@@ -0,0 +1,7 @@
1
+ auth
2
+ ====
3
+
4
+ auth module provides basic pyramid auth helpers
5
+
6
+ .. automodule:: pyramid_fullauth.auth
7
+ :members:
@@ -0,0 +1,58 @@
1
+ events
2
+ ======
3
+
4
+ .. automodule:: pyramid_fullauth.events
5
+
6
+
7
+ Registration
8
+ ------------
9
+
10
+
11
+ .. autoclass:: BeforeRegister
12
+
13
+
14
+ .. autoclass:: AfterRegister
15
+
16
+
17
+ Account activation
18
+ ------------------
19
+
20
+
21
+ .. autoclass:: AfterActivate
22
+
23
+
24
+ Password reset
25
+ --------------
26
+
27
+ .. autoclass:: AfterResetRequest
28
+
29
+
30
+ .. autoclass:: AfterReset
31
+
32
+
33
+ Login
34
+ -----
35
+
36
+
37
+ .. autoclass:: AlreadyLoggedIn
38
+
39
+
40
+ .. autoclass:: BeforeLogIn
41
+
42
+
43
+ .. autoclass:: AfterLogIn
44
+
45
+
46
+ Social registration/login
47
+ -------------------------
48
+
49
+ .. autoclass:: BeforeSocialRegister
50
+
51
+
52
+ .. autoclass:: AfterSocialRegister
53
+
54
+
55
+ .. autoclass:: AfterSocialLogIn
56
+
57
+
58
+ .. autoclass:: SocialAccountAlreadyConnected
@@ -0,0 +1,32 @@
1
+ models
2
+ ======
3
+
4
+ .. automodule:: pyramid_fullauth.models
5
+
6
+
7
+ .. autoclass:: User
8
+ :show-inheritance:
9
+ :members:
10
+
11
+
12
+ .. autoclass:: Group
13
+
14
+
15
+ .. autoclass:: AuthenticationProvider
16
+
17
+
18
+ models.mixins
19
+ -------------
20
+
21
+ .. automodule:: pyramid_fullauth.models.mixins
22
+
23
+
24
+ .. autoclass:: PasswordMixin
25
+ :members: check_password, hash_password, password_validator
26
+
27
+ .. autoattribute:: password
28
+ .. autoattribute:: _hash_algorithm
29
+ .. autoattribute:: _salt
30
+ .. autoattribute:: reset_key
31
+
32
+
@@ -0,0 +1,5 @@
1
+ request
2
+ =======
3
+
4
+ .. automodule:: pyramid_fullauth.request
5
+ :members:
@@ -0,0 +1,6 @@
1
+ tools
2
+ =====
3
+
4
+
5
+ .. automodule:: pyramid_fullauth.tools
6
+ :members:
@@ -0,0 +1,13 @@
1
+ Api
2
+ ===
3
+
4
+ Here's the api for pyramid_fullauth
5
+
6
+ .. toctree::
7
+ :maxdepth: 2
8
+
9
+ api/models
10
+ api/auth
11
+ api/events
12
+ api/request
13
+ api/tools