Easily use XStatic files in flask
Project description
Flask-XStatic-Files
===================
.. image:: https://travis-ci.org/agx/flask-xstatic-files.svg?branch=master
:target: https://travis-ci.org/agx/flask-xstatic-files
.. highlight:: python
A `Flask`_ extionsion to serve `XStatic`_ files. Can be useful if you
don't use an asset pipeline and want to serve e.g. XStatic packaged
javascript files like `JQuery`_ directly.
Setup
-----
Upon initialization tell Flask about the XStatic modules you want to
use. This example uses JQuery and D3::
app = Flask(__name__)
app.config.from_object(__name__)
app.config.['XSTATIC_MODULES'] = ['jquery', 'd3']
xsf = XStaticFiles(app)
The modules can be given as list or comma separated (``jquery,d3``).
Serving Files
-------------
The extension already installs a route handler for you so files under
``/xstatic/<module>/`` are served automatically. To generate these
URLs you can use ``url_for``::
xsf.url_for('jquery', 'jquery.min.js')
In templates you can use ``xstatic_url_for``:
.. code-block:: html
<script type=text/javascript src="{{ xstatic_url_for(module='jquery', path='jquery.min.js') }}"></script>
to generate these URLs. This has the advantage that you can later
serve files from a static web server by adjusting ``XSTATIC_ROOT`` and
``XSTATIC_PROTO`` without having to modify any code.
In case you want to serve XStatic files from other URLs use ``serve``
or ``serve_or_404``::
@app.route('/somewhere-else/jquery/jquery.min.js')
def serve_jquery():
return xsf.serve_or_404('jquery', 'jquery.min.js')
.. _Flask: http://flask.pocoo.org/
.. _XStatic: https://xstatic.readthedocs.io/en/latest/
.. _JQuery: https://pypi.python.org/pypi/XStatic-jQuery
===================
.. image:: https://travis-ci.org/agx/flask-xstatic-files.svg?branch=master
:target: https://travis-ci.org/agx/flask-xstatic-files
.. highlight:: python
A `Flask`_ extionsion to serve `XStatic`_ files. Can be useful if you
don't use an asset pipeline and want to serve e.g. XStatic packaged
javascript files like `JQuery`_ directly.
Setup
-----
Upon initialization tell Flask about the XStatic modules you want to
use. This example uses JQuery and D3::
app = Flask(__name__)
app.config.from_object(__name__)
app.config.['XSTATIC_MODULES'] = ['jquery', 'd3']
xsf = XStaticFiles(app)
The modules can be given as list or comma separated (``jquery,d3``).
Serving Files
-------------
The extension already installs a route handler for you so files under
``/xstatic/<module>/`` are served automatically. To generate these
URLs you can use ``url_for``::
xsf.url_for('jquery', 'jquery.min.js')
In templates you can use ``xstatic_url_for``:
.. code-block:: html
<script type=text/javascript src="{{ xstatic_url_for(module='jquery', path='jquery.min.js') }}"></script>
to generate these URLs. This has the advantage that you can later
serve files from a static web server by adjusting ``XSTATIC_ROOT`` and
``XSTATIC_PROTO`` without having to modify any code.
In case you want to serve XStatic files from other URLs use ``serve``
or ``serve_or_404``::
@app.route('/somewhere-else/jquery/jquery.min.js')
def serve_jquery():
return xsf.serve_or_404('jquery', 'jquery.min.js')
.. _Flask: http://flask.pocoo.org/
.. _XStatic: https://xstatic.readthedocs.io/en/latest/
.. _JQuery: https://pypi.python.org/pypi/XStatic-jQuery
Project details
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
Close
Hashes for Flask-XStatic-Files-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 211e66ea716d972e2af5a446af0abf1c9cf2ed939fddca2da6147038e4707365 |
|
MD5 | 9c9bdc2ce911b180f5f6c232d39d8815 |
|
BLAKE2b-256 | 2e70fa321e3d0a02ec93d9d536b214883c3ce1da0720b327d2f15ce1729f1384 |