Font-Awesome-Flask is an extension for Flask that adds support for Font Awesome to your web application.
Project description
Font-Awesome-Flask
Font-Awesome-Flask is an extension for Flask that adds support for Font Awesome to your web application. It adds methods to load Font Awesome's resources (both Web Fonts + CSS and SVG + JS are supported) and render icons.
Installation
From PyPI
Font-Awesome-Flask is available on PyPI. Install with pip or your package manager of choice:
pip install Font-Awesome-Flask
From source
If you'd like, you can also install Font-Awesome-Flask from source (with flit):
git clone https://github.com/sgraaf/font-awesome-flask.git
cd font-awesome-flask
python3 -m pip install flit
flit install
Documentation
Check out the Font-Awesome-Flask documentation for the User's Guide and API Reference.
Example
Configuration
Font-Awesome-Flask can be configured via the Flask configuration API, using the config attribute of the Flask object. These are the available configuration values along with their description:
| Configuration value | Default | Description |
|---|---|---|
FONT_AWESOME_SERVE_LOCAL |
False |
Whether to serve Font Awesome's resources locally or from the CDN. |
Initialization
Initialize the extension with the Flask application normally...:
from flask import Flask
from flask_font_awesome import FontAwesome
app = Flask(__name__)
font_awesome = FontAwesome(app)
... or using the Application Factory pattern:
from flask import Flask
from flask_font_awesome import FontAwesome
font_awesome = FontAwesome()
def create_app():
app = Flask(__name__)
font_awesome.init_app(app)
return app
Loading resources
Font-Awesome-Flask provides three helper methods to load Font Awesome's resources: font_awesome.load(), font_awesome.load_js() and font_awesome.load_css().
Font Awesome can be used either via Web Fonts + CSS or via SVG + JS. Use the load_css() method for the former, and load_js() for the latter. You can also use the more general load(), which defaults to SVG + JS.
Whichever resource(s) you end up using, you can load them by including any of the load() methods in the head of your base template:
<head>
...
{{ font_awesome.load_js() }}
...
</head>
<body>
...
</body>
Rendering icons
Font-Awesome-Flask provides two ways of rendering icons: via the font_awesome.render_icon() and font_awesome.render_stacked_icons() methods...:
{{font_awesome.render_icon("fas fa-house")}}
{{font_awesome.render_stacked_icons("fas fa-square", "fas fa-house")}}
... or via the Jinja macros of the same names:
{% from 'font_awesome.html' import render_icon, render_stacked_icons %}
{{ render_icon('fas fa-house') }}
{{ render_stacked_icons('fas fa-square', 'fasfa-house') }}
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file font_awesome_flask-0.1.4.tar.gz.
File metadata
- Download URL: font_awesome_flask-0.1.4.tar.gz
- Upload date:
- Size: 568.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 99f25bf3bcbdb3644aec9eabff6dac48a0dbe3b10069f0782bbce6cf6f3c92a6 |
|
| MD5 | 95e35c5ece2dc453f897c115b7023941 |
|
| BLAKE2b-256 | 17609ce62f27b2edaff8695ada9eadbab20102ec6ec1e0105f3de9f14311269e |
File details
Details for the file font_awesome_flask-0.1.4-py3-none-any.whl.
File metadata
- Download URL: font_awesome_flask-0.1.4-py3-none-any.whl
- Upload date:
- Size: 562.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 08d136e5cfa2f8fa5013264456cfda752e730b511a633a9817c662a633e6fa09 |
|
| MD5 | 42123b10ece0d77fe8a0f1c949f4775c |
|
| BLAKE2b-256 | 8c5655632400d3cfcbdabf6812eb180d6d76aaf86e46334e79581d0199ec6ac1 |
