1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
================
Flask-Gravatar
================
.. currentmodule:: flask_gravatar
.. raw:: html
<p style="height:22px; margin:0 0 0 2em; float:right">
<a href="https://travis-ci.org/zzzsochi/flask-gravatar">
<img src="https://travis-ci.org/zzzsochi/flask-gravatar.png?branch=master"
alt="travis-ci badge"/>
</a>
<a href="https://coveralls.io/r/zzzsochi/flask-gravatar">
<img src="https://coveralls.io/repos/zzzsochi/flask-gravatar/badge.png?branch=master"
alt="coveralls.io badge"/>
</a>
</p>
This is small and simple integration `gravatar`_ into `flask`_.
.. _flask: http://flask.pocoo.org
.. _gravatar: http://gravatar.com
Contents
--------
.. contents::
:local:
:depth: 1
:backlinks: none
.. _installation:
Installation
============
Flask-Gravatar is on PyPI so all you need is:
.. code-block:: console
$ pip install Flask-Gravatar
The development version can be downloaded from `its page at GitHub
<http://github.com/zzzsochi/flask-gravatar>`_.
.. code-block:: console
$ git clone https://github.com/zzzsochi/flask-gravatar.git
$ cd flask-gravatar
$ python setup.py develop
$ ./run-tests.sh
.. _usage:
Usage
=====
Initialize with flask application and default parameters:
.. code-block:: python
gravatar = Gravatar(app,
size=100,
rating='g',
default='retro',
force_default=False,
force_lower=False,
use_ssl=False,
base_url=None)
Then in your template:
.. code-block:: jinja
{{ 'zzz.sochi@gmail.com' | gravatar }}
Bigger and adult:
.. code-block:: jinja
{{ 'zzz.sochi@gmail.com' | gravatar(size=200, rating='x') }}
Parameters
----------
All parameters are described in `gravatar documentation`_.
.. _gravatar documentation: http://gravatar.com/site/implement/images
.. _api:
API
===
.. class:: flask_gravatar.Gravatar(app, size=100, rating='g', default='retro', force_default=False, force_lower=False)
Simple object for create gravatar link.
:param app: Your Flask app instance
:type app: flask.Flask
:param size: Default size for avatar
:type size: int
:type size: str
:param rating: Default rating
:type rating: str
:param default: Default type for unregistred emails
:type default: str
:param force_default: Build only default avatars
:type force_default: bool
:param force_lower: Make email.lower() before build link
:type force_lower: bool
.. method:: __call__(email, \*\*kw)
Build gravatar link.
:param email: Email for create link
:param kw: Reload defaults
Default parameters. May change in runtime.
.. attribute:: size
.. attribute:: rating
.. attribute:: default
.. attribute:: force_default
.. attribute:: force_lower
.. include:: ../CHANGES
.. include:: ../CONTRIBUTING.rst
License
=======
.. include:: ../LICENSE
.. include:: ../AUTHORS
|
