mirror of
https://github.com/wassname/flask-security.git
synced 2026-09-09 11:22:35 +08:00
Update docs and tests
This commit is contained in:
Vendored
BIN
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
Vendored
BIN
Binary file not shown.
|
After Width: | Height: | Size: 9.8 KiB |
Vendored
+17
@@ -0,0 +1,17 @@
|
||||
<h3>About</h3>
|
||||
<p>
|
||||
Flask-Security is an opinionated Flask extension which adds basic
|
||||
security and authentication features to your Flask apps quickly
|
||||
and easily. Flask-Social can also be used to add "social" or OAuth
|
||||
login and connection management.
|
||||
</p>
|
||||
<h3>Useful Links</h3>
|
||||
<ul>
|
||||
<li><a href="http://pypi.python.org/pypi/Flask-Security">Flask-Security @ PyPI</a></li>
|
||||
<li><a href="http://github.com/mattupstate/flask-security">Flask-Security @ github</a></li>
|
||||
<li><a href="http://github.com/jfinkels/flask-security/issues">Issue Tracker</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><a href="http://pypi.python.org/pypi/Flask-Social">Flask-Social</a></li>
|
||||
<li><a href="http://github.com/mattupstate/flask-social">Flask-Social @ github</a></li>
|
||||
</ul>
|
||||
Vendored
+3
@@ -0,0 +1,3 @@
|
||||
<p class="logo"><a href="{{ pathto(master_doc) }}">
|
||||
<img class="logo" src="{{ pathto('_static/logo-helmet.png', 1) }}" alt="Logo"/>
|
||||
</a></p>
|
||||
@@ -50,27 +50,6 @@ Datastores
|
||||
:inherited-members:
|
||||
|
||||
|
||||
Exceptions
|
||||
----------
|
||||
.. autoexception:: flask_security.exceptions.BadCredentialsError
|
||||
|
||||
.. autoexception:: flask_security.exceptions.AuthenticationError
|
||||
|
||||
.. autoexception:: flask_security.exceptions.UserNotFoundError
|
||||
|
||||
.. autoexception:: flask_security.exceptions.RoleNotFoundError
|
||||
|
||||
.. autoexception:: flask_security.exceptions.UserDatastoreError
|
||||
|
||||
.. autoexception:: flask_security.exceptions.UserCreationError
|
||||
|
||||
.. autoexception:: flask_security.exceptions.RoleCreationError
|
||||
|
||||
.. autoexception:: flask_security.exceptions.ConfirmationError
|
||||
|
||||
.. autoexception:: flask_security.exceptions.ResetPasswordError
|
||||
|
||||
|
||||
Signals
|
||||
-------
|
||||
See the documentation for the signals provided by the Flask-Login and
|
||||
|
||||
+7
-1
@@ -100,6 +100,8 @@ html_theme = 'flask'
|
||||
html_theme_options = {
|
||||
#'github_fork': 'mattupstate/flask-security',
|
||||
#'index_logo': False
|
||||
'touch_icon': 'touch-icon.png',
|
||||
'index_logo': 'logo-full.png'
|
||||
}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
@@ -135,7 +137,11 @@ html_static_path = ['_static']
|
||||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
html_sidebars = {
|
||||
'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'],
|
||||
'**': ['sidebarlogo.html', 'localtoc.html', 'relations.html',
|
||||
'sourcelink.html', 'searchbox.html']
|
||||
}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
|
||||
@@ -4,7 +4,6 @@ Contents
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
overview
|
||||
features
|
||||
configuration
|
||||
quickstart
|
||||
|
||||
+30
-1
@@ -1,7 +1,36 @@
|
||||
Flask-Security
|
||||
==============
|
||||
|
||||
Flask-Security quickly adds security features to your Flask application.
|
||||
Flask-Security allows you to quickly add common security mechanisms to your
|
||||
Flask application. They include:
|
||||
|
||||
1. Session based authentication
|
||||
2. Role management
|
||||
3. Password encryption
|
||||
4. Basic HTTP authentication
|
||||
5. Token based authentication
|
||||
6. Token based account activation (optional)
|
||||
7. Token based password recovery/resetting (optional)
|
||||
8. User registration (optional)
|
||||
9. Login tracking (optional)
|
||||
|
||||
Many of these features are made possible by integrating various Flask extensions
|
||||
and libraries. They include:
|
||||
|
||||
1. `Flask-Login <http://packages.python.org/Flask-Login/>`_
|
||||
2. `Flask-Mail <http://packages.python.org/Flask-Mail/>`_
|
||||
3. `Flask-Principal <http://packages.python.org/Flask-Principal/>`_
|
||||
4. `Flask-Script <http://packages.python.org/Flask-Script/>`_
|
||||
5. `Flask-WTF <http://packages.python.org/Flask-Mail/>`_
|
||||
6. `itsdangerous <http://packages.python.org/itsdangerous/>`_
|
||||
7. `passlib <http://packages.python.org/passlib/>`_
|
||||
|
||||
Additionally, it assumes you'll be using a common library for your database
|
||||
connections and model definitions. Flask-Security supports the following Flask
|
||||
extensions out of the box for data persistance:
|
||||
|
||||
1. `Flask-SQLAlchemy <http://packages.python.org/Flask-SQLAlchemy/>`_
|
||||
2. `Flask-MongoEngine <http://packages.python.org/Flask-MongoEngine/>`_
|
||||
|
||||
|
||||
.. include:: contents.rst.inc
|
||||
@@ -1,33 +0,0 @@
|
||||
Overview
|
||||
========
|
||||
|
||||
Flask-Security allows you to quickly add common security mechanisms to your
|
||||
Flask application. They include:
|
||||
|
||||
1. Session based authentication
|
||||
2. Role management
|
||||
3. Password encryption
|
||||
4. Basic HTTP authentication
|
||||
5. Token based authentication
|
||||
6. Token based account activation (optional)
|
||||
7. Token based password recovery/resetting (optional)
|
||||
8. User registration (optional)
|
||||
9. Login tracking (optional)
|
||||
|
||||
Many of these features are made possible by integrating various Flask extensions
|
||||
and libraries. They include:
|
||||
|
||||
1. `Flask-Login <http://packages.python.org/Flask-Login/>`_
|
||||
2. `Flask-Mail <http://packages.python.org/Flask-Mail/>`_
|
||||
3. `Flask-Principal <http://packages.python.org/Flask-Principal/>`_
|
||||
4. `Flask-Script <http://packages.python.org/Flask-Script/>`_
|
||||
5. `Flask-WTF <http://packages.python.org/Flask-Mail/>`_
|
||||
6. `itsdangerous <http://packages.python.org/itsdangerous/>`_
|
||||
7. `passlib <http://packages.python.org/passlib/>`_
|
||||
|
||||
Additionally, it assumes you'll be using a common library for your database
|
||||
connections and model definitions. Flask-Security supports the following Flask
|
||||
extensions out of the box for data persistance:
|
||||
|
||||
1. `Flask-SQLAlchemy <http://packages.python.org/Flask-SQLAlchemy/>`_
|
||||
2. `Flask-MongoEngine <http://packages.python.org/Flask-MongoEngine/>`_
|
||||
Reference in New Issue
Block a user