:j{븏~2o)f &G+IG .X!b
!\m bRO"Zv3DoXzܿA!9=k|Ł$q\ Lٟ@O Z:DB#y0OJ ʪyҡ#n=GR UZ% odnhr@'}64[OI |n #~T5%PAcϭ^h#ݸeF)ZՐ ҥh;2 "HqO,Hzm_hPW9#'>#I ѡIz1'ޤhYB <'jƮ@1 3*D`I&F3 J dhFyJ(
Vt{of5Sߎ#fSc6z|(2/ǜSersp1- ϚGXj`{ EsKsѦ flask-peewee-4.0.1/docs/_themes/ 0000775 0000000 0000000 00000000000 15223753015 0016443 5 ustar 00root root 0000000 0000000 flask-peewee-4.0.1/docs/_themes/flask/ 0000775 0000000 0000000 00000000000 15223753015 0017543 5 ustar 00root root 0000000 0000000 flask-peewee-4.0.1/docs/_themes/flask/layout.html 0000664 0000000 0000000 00000001356 15223753015 0021753 0 ustar 00root root 0000000 0000000 {%- extends "basic/layout.html" %}
{%- block extrahead %}
{{ super() }}
{% if theme_touch_icon %}
{% endif %}
{% endblock %}
{%- block relbar2 %}{% endblock %}
{% block header %}
{{ super() }}
{% if pagename == 'index' %}
{% endif %}
{% endblock %}
{%- block footer %}
{% if pagename == 'index' %}
{% endif %}
{%- endblock %}
flask-peewee-4.0.1/docs/_themes/flask/relations.html 0000664 0000000 0000000 00000001116 15223753015 0022430 0 ustar 00root root 0000000 0000000 Related Topics
flask-peewee-4.0.1/docs/_themes/flask/static/ 0000775 0000000 0000000 00000000000 15223753015 0021032 5 ustar 00root root 0000000 0000000 flask-peewee-4.0.1/docs/_themes/flask/static/flasky.css_t 0000664 0000000 0000000 00000014444 15223753015 0023367 0 ustar 00root root 0000000 0000000 /*
* flasky.css_t
* ~~~~~~~~~~~~
*
* :copyright: Copyright 2010 by Armin Ronacher.
* :license: Flask Design License, see LICENSE for details.
*/
{% set page_width = '940px' %}
{% set sidebar_width = '220px' %}
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
body {
font-family: 'Georgia', serif;
font-size: 17px;
background-color: white;
color: #000;
margin: 0;
padding: 0;
}
div.document {
width: {{ page_width }};
margin: 30px auto 0 auto;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 {{ sidebar_width }};
}
div.sphinxsidebar {
width: {{ sidebar_width }};
}
hr {
border: 1px solid #B1B4B6;
}
div.body {
background-color: #ffffff;
color: #3E4349;
padding: 0 30px 0 30px;
}
img.floatingflask {
padding: 0 0 10px 10px;
float: right;
}
div.footer {
width: {{ page_width }};
margin: 20px auto 30px auto;
font-size: 14px;
color: #888;
text-align: right;
}
div.footer a {
color: #888;
}
div.related {
display: none;
}
div.sphinxsidebar a {
color: #444;
text-decoration: none;
border-bottom: 1px dotted #999;
}
div.sphinxsidebar a:hover {
border-bottom: 1px solid #999;
}
div.sphinxsidebar {
font-size: 14px;
line-height: 1.5;
}
div.sphinxsidebarwrapper {
padding: 18px 10px;
}
div.sphinxsidebarwrapper p.logo {
padding: 0 0 20px 0;
margin: 0;
text-align: center;
}
div.sphinxsidebar h3,
div.sphinxsidebar h4 {
font-family: 'Garamond', 'Georgia', serif;
color: #444;
font-size: 24px;
font-weight: normal;
margin: 0 0 5px 0;
padding: 0;
}
div.sphinxsidebar h4 {
font-size: 20px;
}
div.sphinxsidebar h3 a {
color: #444;
}
div.sphinxsidebar p.logo a,
div.sphinxsidebar h3 a,
div.sphinxsidebar p.logo a:hover,
div.sphinxsidebar h3 a:hover {
border: none;
}
div.sphinxsidebar p {
color: #555;
margin: 10px 0;
}
div.sphinxsidebar ul {
margin: 10px 0;
padding: 0;
color: #000;
}
div.sphinxsidebar input {
border: 1px solid #ccc;
font-family: 'Georgia', serif;
font-size: 1em;
}
/* -- body styles ----------------------------------------------------------- */
a {
color: #004B6B;
text-decoration: underline;
}
a:hover {
color: #6D4100;
text-decoration: underline;
}
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: 'Garamond', 'Georgia', serif;
font-weight: normal;
margin: 30px 0px 10px 0px;
padding: 0;
}
{% if theme_index_logo %}
div.indexwrapper h1 {
text-indent: -999999px;
background: url({{ theme_index_logo }}) no-repeat center center;
height: {{ theme_index_logo_height }};
}
{% endif %}
div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
div.body h2 { font-size: 180%; }
div.body h3 { font-size: 150%; }
div.body h4 { font-size: 130%; }
div.body h5 { font-size: 100%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #ddd;
padding: 0 4px;
text-decoration: none;
}
a.headerlink:hover {
color: #444;
background: #eaeaea;
}
div.body p, div.body dd, div.body li {
line-height: 1.4em;
}
div.admonition {
background: #fafafa;
margin: 20px -30px;
padding: 10px 30px;
border-top: 1px solid #ccc;
border-bottom: 1px solid #ccc;
}
div.admonition tt.xref, div.admonition a tt {
border-bottom: 1px solid #fafafa;
}
dd div.admonition {
margin-left: -60px;
padding-left: 60px;
}
div.admonition p.admonition-title {
font-family: 'Garamond', 'Georgia', serif;
font-weight: normal;
font-size: 24px;
margin: 0 0 10px 0;
padding: 0;
line-height: 1;
}
div.admonition p.last {
margin-bottom: 0;
}
div.highlight {
background-color: white;
}
dt:target, .highlight {
background: #FAF3E8;
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
}
div.seealso {
background-color: #ffc;
border: 1px solid #ff6;
}
div.topic {
background-color: #eee;
}
p.admonition-title {
display: inline;
}
p.admonition-title:after {
content: ":";
}
pre, tt {
font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
font-size: 0.9em;
}
img.screenshot {
}
tt.descname, tt.descclassname {
font-size: 0.95em;
}
tt.descname {
padding-right: 0.08em;
}
img.screenshot {
-moz-box-shadow: 2px 2px 4px #eee;
-webkit-box-shadow: 2px 2px 4px #eee;
box-shadow: 2px 2px 4px #eee;
}
table.docutils {
border: 1px solid #888;
-moz-box-shadow: 2px 2px 4px #eee;
-webkit-box-shadow: 2px 2px 4px #eee;
box-shadow: 2px 2px 4px #eee;
}
table.docutils td, table.docutils th {
border: 1px solid #888;
padding: 0.25em 0.7em;
}
table.field-list, table.footnote {
border: none;
-moz-box-shadow: none;
-webkit-box-shadow: none;
box-shadow: none;
}
table.footnote {
margin: 15px 0;
width: 100%;
border: 1px solid #eee;
background: #fdfdfd;
font-size: 0.9em;
}
table.footnote + table.footnote {
margin-top: -15px;
border-top: none;
}
table.field-list th {
padding: 0 0.8em 0 0;
}
table.field-list td {
padding: 0;
}
table.footnote td.label {
width: 0px;
padding: 0.3em 0 0.3em 0.5em;
}
table.footnote td {
padding: 0.3em 0.5em;
}
dl {
margin: 0;
padding: 0;
}
dl dd {
margin-left: 30px;
}
blockquote {
margin: 0 0 0 30px;
padding: 0;
}
ul, ol {
margin: 10px 0 10px 30px;
padding: 0;
}
pre {
background: #eee;
padding: 7px 30px;
margin: 15px -30px;
line-height: 1.3em;
}
dl pre, blockquote pre, li pre {
margin-left: -60px;
padding-left: 60px;
}
dl dl pre {
margin-left: -90px;
padding-left: 90px;
}
tt {
background-color: #ecf0f3;
color: #222;
/* padding: 1px 2px; */
}
tt.xref, a tt {
background-color: #FBFBFB;
border-bottom: 1px solid white;
}
a.reference {
text-decoration: none;
border-bottom: 1px dotted #004B6B;
}
a.reference:hover {
border-bottom: 1px solid #6D4100;
}
a.footnote-reference {
text-decoration: none;
font-size: 0.7em;
vertical-align: top;
border-bottom: 1px dotted #004B6B;
}
a.footnote-reference:hover {
border-bottom: 1px solid #6D4100;
}
a:hover tt {
background: #EEE;
}
flask-peewee-4.0.1/docs/_themes/flask/static/small_flask.css 0000664 0000000 0000000 00000001720 15223753015 0024034 0 ustar 00root root 0000000 0000000 /*
* small_flask.css_t
* ~~~~~~~~~~~~~~~~~
*
* :copyright: Copyright 2010 by Armin Ronacher.
* :license: Flask Design License, see LICENSE for details.
*/
body {
margin: 0;
padding: 20px 30px;
}
div.documentwrapper {
float: none;
background: white;
}
div.sphinxsidebar {
display: block;
float: none;
width: 102.5%;
margin: 50px -30px -20px -30px;
padding: 10px 20px;
background: #333;
color: white;
}
div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
div.sphinxsidebar h3 a {
color: white;
}
div.sphinxsidebar a {
color: #aaa;
}
div.sphinxsidebar p.logo {
display: none;
}
div.document {
width: 100%;
margin: 0;
}
div.related {
display: block;
margin: 0;
padding: 10px 0 20px 0;
}
div.related ul,
div.related ul li {
margin: 0;
padding: 0;
}
div.footer {
display: none;
}
div.bodywrapper {
margin: 0;
}
div.body {
min-height: 0;
padding: 0;
}
flask-peewee-4.0.1/docs/_themes/flask/theme.conf 0000664 0000000 0000000 00000000244 15223753015 0021514 0 ustar 00root root 0000000 0000000 [theme]
inherit = basic
stylesheet = flasky.css
pygments_style = flask_theme_support.FlaskyStyle
[options]
index_logo = ''
index_logo_height = 120px
touch_icon =
flask-peewee-4.0.1/docs/admin.rst 0000664 0000000 0000000 00000037444 15223753015 0016655 0 ustar 00root root 0000000 0000000 .. _admin-interface:
Admin Interface
===============
Many web applications ship with an "admin area", where priveleged users can
view and modify content. By introspecting your application's models, flask-peewee
can provide you with straightforward, easily-extensible forms for managing your
application content.
Here's a screen-shot of the admin dashboard:
.. image:: fp-admin.png
You can also try out a custom theme. Here is the *crux* theme:
.. image:: fp-crux-full.png
Getting started
---------------
To get started with the admin, there are just a couple steps:
1. Instantiate an :py:class:`Auth` backend for your project -- this component
is responsible for providing the security for the admin area
.. code-block:: python
from flask import Flask
from flask_peewee.auth import Auth
from flask_peewee.db import Database
app = Flask(__name__)
db = Database(app)
# needed for authentication
auth = Auth(app, db)
2. Instantiate an :py:class:`Admin` object
.. code-block:: python
# continued from above...
from flask_peewee.admin import Admin
admin = Admin(app, auth)
3. Register any :py:class:`ModelAdmin` or :py:class:`AdminPanel` objects you
would like to expose via the admin
.. code-block:: python
# continuing... assuming "Blog" and "Entry" models
admin.register(Blog) # register "Blog" with vanilla ModelAdmin
admin.register(Entry, EntryAdmin) # register "Entry" with a custom ModelAdmin subclass
# assume we have an "AdminPanel" called "NotePanel"
admin.register_panel('Notes', NotePanel)
4. Call :py:meth:`Admin.setup()`, which registers the admin blueprint and configures the urls
.. code-block:: python
# after all models and panels are registered, configure the urls
admin.setup()
.. note::
For a complete example, check the `example app
`_ which ships
with the project.
Customizing how models are displayed
------------------------------------
We'll use the "Message" model taken from the `example app `_,
which looks like this:
.. code-block:: python
class Message(db.Model):
user = ForeignKeyField(User)
content = TextField()
pub_date = DateTimeField(default=datetime.datetime.now)
def __str__(self):
return '%s: %s' % (self.user, self.content)
If we were to simply register this model with the admin, it would look something
like this:
.. code-block:: python
admin = Admin(app, auth)
admin.register(Message)
admin.setup()
.. image:: fp-message-admin-plain.png
A quick way to improve the appearance of this view is to specify which columns
to display. To start customizing how the ``Message`` model is displayed in the
admin, we'll subclass :py:class:`ModelAdmin`.
.. code-block:: python
from flask_peewee.admin import ModelAdmin
class MessageAdmin(ModelAdmin):
columns = ('user', 'content', 'pub_date',)
foreign_key_lookups = {'user': 'username'}
filter_fields = ('user', 'content', 'pub_date', 'user__username')
search_fields = ('content', 'user__username')
admin.register(Message, MessageAdmin)
admin.setup()
Now the admin shows all the columns and they can be clicked to sort the data.
Filtering is available, as is search:
.. image:: fp-message-admin.png
Searching
^^^^^^^^^
Set ``search_fields`` to add a quick-search box above the list. It runs a
case-insensitive substring match over char/text fields and supports ``__``
traversal into related models -- so ``('content', 'user__username')`` searches
both the message body and the author's username, joining ``User`` automatically:
.. code-block:: python
class MessageAdmin(ModelAdmin):
columns = ('user', 'content', 'pub_date',)
search_fields = ('content', 'user__username')
Leaving ``search_fields`` empty (the default) hides the search box entirely.
Filtering
^^^^^^^^^
The list and export views expose per-field filters (equals, less-than, contains,
etc., chosen by field type). By default every field is filterable; two
attributes narrow that:
* ``filter_fields`` -- a whitelist of the only fields that may be filtered
* ``filter_exclude`` -- a blacklist of fields to hide from filtering
Both accept ``__`` notation for related fields, so
``filter_exclude = ('user__password',)`` keeps a sensitive related column out of
the filter UI entirely.
Restricting the queryset
^^^^^^^^^^^^^^^^^^^^^^^^^
Suppose privacy is a big concern, and under no circumstances should a user be
able to see another user's messages -- even in the admin. This can be done by overriding
the :py:meth:`~ModelAdmin.get_query` method:
.. code-block:: python
def get_query(self):
return self.model.select().where(self.model.user == g.user)
Now a user will only be able to see and edit their own messages.
Overriding Admin Templates
^^^^^^^^^^^^^^^^^^^^^^^^^^
Use the :py:meth:`ModelAdmin.get_template_overrides` method to override templates
for an individual ``Model``:
.. code-block:: python
class MessageAdmin(ModelAdmin):
# ...
def get_template_overrides(self):
# override the edit template with a custom one
return {'edit': 'messages/admin/edit.html'}
admin.register(Message, MessageAdmin)
This instructs the admin to use a custom template for the edit page in the Message
admin. That template is stored in the application's templates. It might look
something like this:
.. code-block:: jinja
{% extends "admin/models/edit.html" %} {# override the default edit template #}
{# override any blocks here #}
There are five templates that can be overridden:
* index
* add
* edit
* delete
* export
Nicer display for Foreign Key fields
------------------------------------
By default a foreign key renders as a ``