https://github.com/robpol86/flask-statics-helper
Provides Bootstrap3 and other static resources in a modular fashion.
https://github.com/robpol86/flask-statics-helper
Last synced: 9 months ago
JSON representation
Provides Bootstrap3 and other static resources in a modular fashion.
- Host: GitHub
- URL: https://github.com/robpol86/flask-statics-helper
- Owner: Robpol86
- License: mit
- Archived: true
- Created: 2014-07-09T17:19:19.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-11-26T20:27:07.000Z (over 11 years ago)
- Last Synced: 2025-01-01T02:02:32.670Z (over 1 year ago)
- Language: JavaScript
- Size: 5.51 MB
- Stars: 2
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flask-Statics-Helper
Provides Bootstrap3 and other static resources in a modular fashion.
The main purpose of this extension is to "modularize" static resources (css and js files) on a per-template basis. In a
large Flask application, all views/templates don't use the same static resource such as d3js. If only one view uses d3js
out of five or more, there is no reason to have the d3js `` tag included in all views.
This extension also provides a base template to be extended by your Flask application's templates for Bootstrap3 (like
other Bootstrap3 extensions such as [this](https://github.com/mbr/flask-bootstrap) or
[this](https://github.com/ryanolson/flask-bootstrap3)).
* Python 2.6, 2.7, 3.3, and 3.4 supported on Linux and OS X.
* Python 2.7, 3.3, and 3.4 supported on Windows (both 32 and 64 bit versions of Python).
[]
(https://ci.appveyor.com/project/Robpol86/Flask-Statics-Helper)
[]
(https://travis-ci.org/Robpol86/Flask-Statics-Helper)
[]
(https://codecov.io/github/Robpol86/Flask-Statics-Helper)
[]
(https://pypi.python.org/pypi/Flask-Statics-Helper/)
[]
(https://pypi.python.org/pypi/Flask-Statics-Helper/)
## Quickstart
Install:
```bash
pip install Flask-Statics-Helper
```
Enable:
```python
# example.py
from flask import Flask
from flask.ext.statics import Statics
app = Flask(__name__)
Statics(app)
```
Use with Bootstrap3 (automatically enables jQuery):
```html+django
{% extends 'flask_statics_helper/bootstrap.html' %}
{% set STATICS_ENABLE_RESOURCE_CSSHAKE = True %}
{% block title %}My Application{% endblock %}
{% block navbar %}
{% endblock %}
{% block container %}
Hello World.
{% endblock %}
```
## Available Resources
* [Bootstrap](http://getbootstrap.com/) 3.3.1
* [jQuery](http://jquery.com/) 2.1.1
* [Angular JS](https://angularjs.org/) 1.3.4
* [Bootstrap Growl](https://github.com/mouse0270/bootstrap-growl) 2.0.0
* [Bootstrap X-Editable](http://vitalets.github.io/x-editable/) 1.5.1
* [BootstrapValidator](http://bootstrapvalidator.com/) 0.5.3
* [CSShake](https://github.com/elrumordelaluz/csshake) (cloned July 9, 2014)
* [D3](http://d3js.org/) 3.4.13
* [Data Tables](http://datatables.net/) 1.10.4
* [Font Awesome](http://fortawesome.github.io/Font-Awesome/) 4.2.0
* [WHHG Font](http://www.webhostinghub.com/glyphs/) (cloned November 26, 2014)
* [typeahead.js](https://github.com/twitter/typeahead.js) 0.10.5
## Configuration
The only `app.config` specific setting is `STATICS_MINIFY`. Everything else may be set to True either in individual
templates (so that css/js is included only for that template) or you may set it to True in the `app.config` if you want
the resource enabled for all templates for some reason or another.
The following config settings are searched for in the Flask application's configuration dictionary:
* `STATICS_MINIFY` -- Have minified resources selected instead of uncompressed resources.
* `STATICS_ENABLE_RESOURCE_ANGULARJS` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_BOOTSTRAP` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_BOOTSTRAP_EDITABLE` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_BOOTSTRAP_GROWL` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_BOOTSTRAP_TYPEAHEAD` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_BOOTSTRAP_VALIDATOR` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_CSSHAKE` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_D3` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_DATATABLES` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_FONT_AWESOME` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_JQUERY` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_WHHG_FONT` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_ANGULARJS_ANIMATE` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_ANGULARJS_COOKIES` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_ANGULARJS_CSP` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_ANGULARJS_LOADER` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_ANGULARJS_MESSAGES` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_ANGULARJS_MOCKS` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_ANGULARJS_RESOURCE` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_ANGULARJS_ROUTE` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_ANGULARJS_SANITIZE` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_ANGULARJS_SCENARIO` -- include resource in all templates.
* `STATICS_ENABLE_RESOURCE_ANGULARJS_TOUCH` -- include resource in all templates.
## Changelog
#### 1.0.0
* Windows compatibility.
* Updated Bootstrap to 3.3.1.
* Updated Angular JS to 1.3.4.
* Updated BootstrapValidator to 0.5.3.
* Updated D3 to 3.4.13.
* Updated Data Tables to 1.10.4.
* Updated Font Awesome to 4.2.0.
* Updated WHHG Font to latest as of November 26, 2014.
#### 0.3.0
* Replaced Bootstrap 3 Typeahead with Twitter typeahead.js.
#### 0.2.0
* Added BootstrapValidator resource.
#### 0.1.1
* Added Python 2.6 and 3.x support.
#### 0.1.0
* Initial release.