Flask-Silk¶

Flask-Silk is small Flask extension. It adds silk icons to your Flask application or module, or extension!

Silk is very awesome. It will be good for your Flask extensions. But if someone use many Flask extensions which contains silk icons, they will lose their storage space too much. They can solve the problem with Flask-Silk.

If you want to preview silk icons, visit Silk Icon Dictionary.

Note

Silk is licensed under a Creative Commons Attribution 2.5 License or 3.0 License. Before using the icons, read the license.

Installation¶

Check out development version:

$ git clone git://github.com/sublee/flask-silk.git

How to Use¶

If you want to contain silk icons to your application, follow the below example:

from flask import Flask
from flaskext.silk import Silk
app = Flask(__name__)
silk = Silk(app)

In your application, you can get an icon’s url by:

url_for("silkicon", filename="bug.png")

It also works with Flask module:

from flask import Module
from flaskext.silk import Silk
mod = Module(__name__)
silk = Silk(mod)

API¶

class flaskext.silk.Silk(base, silk_path='/icons')¶

This small extension adds silkicon() to your Flask application:

from flask import Flask
from flaskext.silk import Silk
app = Flask(__name__)
silk = Silk(app)

Or it works with your Flask module:

from flask import Module
from flaskext.silk import Silk
mod = Module(__name__)
silk = Silk(mod)

Parameters:	base – a flask application or module silk_path – a path to serve silk icons. default is `/icons`.

flaskext.silk.send_silkicon(filename=None, iconname=None, ext='png')¶

Sends a silk icon. The icon is in a shared directory.

An example:

from flaskext.silk import send_silkicon
from myapplication import app
@app.route("/static/icons/<filename>")
def icon(filename):
    return send_silkicon(filename)

Indices and tables¶