| Name | flask-strip-whitespace JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | A powerful HTML whitespace remover for Flask |
| upload_time | 2023-02-01 10:19:21 |
| maintainer | |
| docs_url | None |
| author | baseplate-admin |
| requires_python | >=3.7,<4.0 |
| license | GPLv3 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
HTML Whitespace remover for Flask
==================================
|Pepy.tech Badge| |PyPi Version Badge| |Python Versions Badge| |License Badge| |Code Style|
.. |Pepy.tech Badge| image:: https://static.pepy.tech/personalized-badge/flask-strip-whitespace?period=week&units=international_system&left_color=grey&right_color=orange&left_text=Downloads
:target: https://pepy.tech/project/flask-strip-whitespace
.. |PyPi Version Badge| image:: https://badge.fury.io/py/flask-strip-whitespace.svg
:target: https://badge.fury.io/py/flask-strip-whitespace
.. |Python Versions Badge| image:: https://img.shields.io/pypi/pyversions/flask-strip-whitespace
:alt: PyPI - Python Version
:target: https://github.com/baseplate-admin/flask_strip_whitespace/blob/main/setup.py
.. |License Badge| image:: https://img.shields.io/pypi/l/flask-strip-whitespace
:alt: PyPI - License
:target: https://github.com/baseplate-admin/flask_strip_whitespace/blob/main/LICENSE
.. |Code Style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:alt: Code Style
Introduction :
--------------
A powerful tool to optimize Flask rendered templates
Why use "flask_stip_whitespace" ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Adds line break to InlineJS.
* It can automagically minify inline CSS, JS.
* Removes <!--prettier-ignore--> from HTML.
* It speeds up website by reducing the HTML size.
* It compiles regex at runtime. So it's blazing fast.
* Its mostly based on C ( gzip ) and Rust ( `minify-html <https://pypi.org/project/minify-html/>`__ ) libraries.
* Significantly lower bytes transferred when working with frameworks like AlpineJs ( Almost fully working & Please open a issue in the `Issue Tracker <https://github.com/baseplate-admin/flask_strip_whitespace/issues>`__ if you encounter any bug) & Petite Vue.
* Is very customizable. ( You can configure lower level `minify-html <https://github.com/wilsonzlin/minify-html/blob/master/python/src/lib.template.rs/>`_ rust bindings and also the lower level `python <https://github.com/juancarlospaco/css-html-js-minify/blob/master/css_html_js_minify/html_minifier.py/>`_ bindings from flask's configuration )
Why shouldn't you use "flask_stip_whitespace" ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* You don't like having unnecessary ';;' in your HTML. ( If you know any regex to fix this please put a pull request )
* Although I tried my best to use Compiled Language for Optimizations. It can still be sub miliseconds ( > 0.001 ) slower compared to normal Flask Rendering. ( If you know any way to improve performance, please put a pull request )
Requirements :
--------------
* `python-strip-whitespace <https://github.com/baseplate-admin/python_strip_whitespace>`_
* Flask
* Python 3 ( Should work with all version? )
* Brotli ( or BrotliPy; pypy ) | ( Optional )
* ZSTD ( Optional )
User guide :
============
Installation :
--------------
Install with pip from pypi (No extra dependencies)::
$ python -m pip install flask_strip_whitespace
Install with pip with Brotli support::
$ python -m pip install flask_strip_whitespace[brotli]
Same but with Zstandard support::
$ python -m pip install flask_strip_whitespace[zstd]
Install with pip from github ( Development | Not Recommended for Production )::
$ python -m pip install https://codeload.github.com/baseplate-admin/flask_strip_whitespace/zip/refs/heads/main
Then include it in your flask project:
.. code-block:: python
from flask_strip_whitespace.middlewares import HTMLStripWhiteSpaceMiddleware
# Declare a dictionary to store config.
# Note that this dictionary must be called before adding wsgi middleware.
STRIP_WHITESPACE_CONFIG : dict = {}
app = Flask(__name__)
app.wsgi_app = HTMLStripWhiteSpaceMiddleware(app.wsgi_app, config=STRIP_WHITESPACE_CONFIG) # Note that config is a python dictionary
Customization :
===============
Change Lower Level Bindings :
-----------------------------
Rust :
~~~~~~
The module allows `rust <https://github.com/wilsonzlin/minify-html>`_ minifier options to be changed from Flask's environ variables. If you would like to change any settings, refer to `minify-html's <https://github.com/wilsonzlin/minify-html/blob/master/python/src/lib.template.rs/>`_ source code.
The bindings are ( by default set to True ):
.. code-block:: python
STRIP_WHITESPACE_RUST_DO_NOT_MINIFY_DOCTYPE, # passes do_not_minify_doctype to minify-html
STRIP_WHITESPACE_RUST_ENSURE_SPEC_CONPLIANT_UNQUOTED_ATTRIBUTE_VALUES, # passes ensure_spec_compliant_unquoted_attribute_values to minify-html
STRIP_WHITESPACE_RUST_KEEP_CLOSING_TAGS, # passes keep_closing_tags to minify-html
STRIP_WHITESPACE_RUST_KEEP_COMMENTS, # passes keep_comments to minify-html
STRIP_WHITESPACE_RUST_KEEP_HTML_AND_HEAD_OPENING_TAGS, # passes keep_html_and_head_opening_tags to minify-html
STRIP_WHITESPACE_RUST_KEEP_SPACES_BETWEEN_ATTRIBUTES, # passes keep_spaces_between_attributes to minify-html
STRIP_WHITESPACE_RUST_MINIFY_CSS, # passes minify_css to minify-html
STRIP_WHITESPACE_RUST_MINIFY_JS, # passes minify_js to minify-html
STRIP_WHITESPACE_RUST_REMOVE_BANGS, # passes remove_bangs to minify-html
STRIP_WHITESPACE_RUST_REMOVE_PROCESSING_INSTRUCTIONS, # passes remove_processing_instructions to minify-html
If you would like to change any of the above variables, simply put them in STRIP_WHITESPACE_CONFIG ( Please note that every variable here is a python boolean ).
For example:
.. code-block:: python
STRIP_WHITESPACE_CONFIG['STRIP_WHITESPACE_RUST_DO_NOT_MINIFY_DOCTYPE'] = False
Python :
~~~~~~~~
The module allows python minifier options to be changed from Flasks's environ variables. If you would like to change any settings, refer to `python-module's <https://github.com/juancarlospaco/css-html-js-minify/blob/master/css_html_js_minify/html_minifier.py/>`_ source code.
The bindings are ( by default set to a sane value ):
.. code-block:: python
STRIP_WHITESPACE_PYTHON_REMOVE_COMMENTS, # False | removes comments from HTML using python ( not recommended cause rust can do that just fine and fast )
STRIP_WHITESPACE_PYTHON_CONDENSE_STYLE_FROM_HTML, # True | replaces '<style text/css>' -> '<style>'
STRIP_WHITESPACE_PYTHON_CONDENSE_SCRIPT_FROM_HTML, # True | replaces '<script text/javascript>' -> '<script>'
STRIP_WHITESPACE_PYTHON_CLEAN_UNNEEDED_HTML_TAGS, # True | removes some unnecessary tags
STRIP_WHITESPACE_PYTHON_CONDENSE_HTML_WHITESPACE, # True | This is where the magic happens.
STRIP_WHITESPACE_PYTHON_UNQUOTE_HTML_ATTRIBUTES, # True | This is also a magic module.
If you would like to change any of the above variables, simply put them in STRIP_WHITESPACE_CONFIG ( Please note that every variable here is a python boolean )
For example:
.. code-block:: python
STRIP_WHITESPACE_CONFIG['STRIP_WHITESPACE_PYTHON_REMOVE_COMMENTS'] = True
Change Ignored Paths :
----------------------
This module allows dynamic ignored path allocation.
So for example if your sitemap.xml is at url '/sitemap.xml' and you want to avoid minifying it ( Because this module in lower level is meant to minify HTML not XML ).
Then you can add it to ignored path. ( By default it ignores '/sitemap.xml' )
To customize ignored path:
.. code-block:: python
STRIP_WHITESPACE_CONFIG['STRIP_WHITESPACE_MINIFY_IGNORED_PATHS'].append("/robots.txt") # Note that STRIP_WHITESPACE_MINIFY_IGNORED_PATHS is a Python List
Change NBSP Mangle Character :
------------------------------
This module first replaces the character from html with a character.
For example becomes 'āĻ
' ( I picked 'āĻ
' because its a foreign character and not many sites use the character like this 'āĻ
' ).
If for some reason this character is causing problem in your HTML. You can change this from STRIP_WHITESPACE_CONFIG .
To change mangle character:
.. code-block:: python
# Keep the string as short as possible.
# If you make it long,
# the python str.replace() method will use more CPU and RAM thus slowing your site down.
STRIP_WHITESPACE_CONFIG["STRIP_WHITESPACE_NBSP_MANGLE_CHARACTER"] = 'ga' # Note that STRIP_WHITESPACE_NBSP_MANGLE_CHARACTER is a python string
Change Compression Settings :
-----------------------------
This module can do the work of compressing response to gzip. ( It can also do brotli, zstd đ )
To change the compression algorithm ( by default using 'gzip' because it's a python stdlib):
.. code-block:: python
# envrion
STRIP_WHITESPACE_CONFIG["STRIP_WHITESPACE_COMPRESSION_ALGORITHM"] = "gzip" or "br" or "zstd" or "plain"
Contributing :
==============
If you like this project add a star.
If you have problems or suggestions please put them in the `Issue Tracker <https://github.com/baseplate-admin/flask_strip_whitespace/issues>`__.
If you like to add features. Fork this repo and submit a Pull Request. đ
Updates ?? :
============
This repository is freezed. It will automatically install latest `python-strip-whitespace <https://github.com/baseplate-admin/python_strip_whitespace>`_
Raw data
{
"_id": null,
"home_page": "",
"name": "flask-strip-whitespace",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "baseplate-admin",
"author_email": "61817579+baseplate-admin@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/51/51/3c7c088ffaa57b9ce31e8d14cc7ae9ed74d393a66b6dba50334b5ec3e89d/flask_strip_whitespace-0.1.0.tar.gz",
"platform": null,
"description": "HTML Whitespace remover for Flask\n==================================\n|Pepy.tech Badge| |PyPi Version Badge| |Python Versions Badge| |License Badge| |Code Style|\n\n.. |Pepy.tech Badge| image:: https://static.pepy.tech/personalized-badge/flask-strip-whitespace?period=week&units=international_system&left_color=grey&right_color=orange&left_text=Downloads\n :target: https://pepy.tech/project/flask-strip-whitespace\n\n.. |PyPi Version Badge| image:: https://badge.fury.io/py/flask-strip-whitespace.svg\n :target: https://badge.fury.io/py/flask-strip-whitespace\n\n.. |Python Versions Badge| image:: https://img.shields.io/pypi/pyversions/flask-strip-whitespace\n :alt: PyPI - Python Version\n :target: https://github.com/baseplate-admin/flask_strip_whitespace/blob/main/setup.py\n\n.. |License Badge| image:: https://img.shields.io/pypi/l/flask-strip-whitespace\n :alt: PyPI - License\n :target: https://github.com/baseplate-admin/flask_strip_whitespace/blob/main/LICENSE\n \n.. |Code Style| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :alt: Code Style\n \nIntroduction :\n--------------\nA powerful tool to optimize Flask rendered templates\n\nWhy use \"flask_stip_whitespace\" ?\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Adds line break to InlineJS.\n* It can automagically minify inline CSS, JS.\n* Removes <!--prettier-ignore--> from HTML.\n* It speeds up website by reducing the HTML size.\n* It compiles regex at runtime. So it's blazing fast.\n* Its mostly based on C ( gzip ) and Rust ( `minify-html <https://pypi.org/project/minify-html/>`__ ) libraries.\n* Significantly lower bytes transferred when working with frameworks like AlpineJs ( Almost fully working & Please open a issue in the `Issue Tracker <https://github.com/baseplate-admin/flask_strip_whitespace/issues>`__ if you encounter any bug) & Petite Vue.\n* Is very customizable. ( You can configure lower level `minify-html <https://github.com/wilsonzlin/minify-html/blob/master/python/src/lib.template.rs/>`_ rust bindings and also the lower level `python <https://github.com/juancarlospaco/css-html-js-minify/blob/master/css_html_js_minify/html_minifier.py/>`_ bindings from flask's configuration )\n\n\nWhy shouldn't you use \"flask_stip_whitespace\" ?\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* You don't like having unnecessary ';;' in your HTML. ( If you know any regex to fix this please put a pull request )\n\n* Although I tried my best to use Compiled Language for Optimizations. It can still be sub miliseconds ( > 0.001 ) slower compared to normal Flask Rendering. ( If you know any way to improve performance, please put a pull request )\n\n\nRequirements :\n--------------\n\n* `python-strip-whitespace <https://github.com/baseplate-admin/python_strip_whitespace>`_\n* Flask\n* Python 3 ( Should work with all version? )\n* Brotli ( or BrotliPy; pypy ) | ( Optional )\n* ZSTD ( Optional ) \n\nUser guide :\n============\n\nInstallation :\n--------------\n\nInstall with pip from pypi (No extra dependencies)::\n\n $ python -m pip install flask_strip_whitespace\n\nInstall with pip with Brotli support::\n\n $ python -m pip install flask_strip_whitespace[brotli]\n\nSame but with Zstandard support::\n\n $ python -m pip install flask_strip_whitespace[zstd]\n\n\n\n\nInstall with pip from github ( Development | Not Recommended for Production )::\n \n $ python -m pip install https://codeload.github.com/baseplate-admin/flask_strip_whitespace/zip/refs/heads/main\n\n\nThen include it in your flask project:\n \n.. code-block:: python\n\n from flask_strip_whitespace.middlewares import HTMLStripWhiteSpaceMiddleware\n\n # Declare a dictionary to store config. \n # Note that this dictionary must be called before adding wsgi middleware.\n STRIP_WHITESPACE_CONFIG : dict = {}\n\n app = Flask(__name__)\n app.wsgi_app = HTMLStripWhiteSpaceMiddleware(app.wsgi_app, config=STRIP_WHITESPACE_CONFIG) # Note that config is a python dictionary \n\nCustomization :\n===============\n\nChange Lower Level Bindings :\n-----------------------------\n\nRust :\n~~~~~~\n\nThe module allows `rust <https://github.com/wilsonzlin/minify-html>`_ minifier options to be changed from Flask's environ variables. If you would like to change any settings, refer to `minify-html's <https://github.com/wilsonzlin/minify-html/blob/master/python/src/lib.template.rs/>`_ source code.\n\n\nThe bindings are ( by default set to True ):\n\n.. code-block:: python\n\n STRIP_WHITESPACE_RUST_DO_NOT_MINIFY_DOCTYPE, # passes do_not_minify_doctype to minify-html\n STRIP_WHITESPACE_RUST_ENSURE_SPEC_CONPLIANT_UNQUOTED_ATTRIBUTE_VALUES, # passes ensure_spec_compliant_unquoted_attribute_values to minify-html\n STRIP_WHITESPACE_RUST_KEEP_CLOSING_TAGS, # passes keep_closing_tags to minify-html\n STRIP_WHITESPACE_RUST_KEEP_COMMENTS, # passes keep_comments to minify-html\n STRIP_WHITESPACE_RUST_KEEP_HTML_AND_HEAD_OPENING_TAGS, # passes keep_html_and_head_opening_tags to minify-html\n STRIP_WHITESPACE_RUST_KEEP_SPACES_BETWEEN_ATTRIBUTES, # passes keep_spaces_between_attributes to minify-html\n STRIP_WHITESPACE_RUST_MINIFY_CSS, # passes minify_css to minify-html\n STRIP_WHITESPACE_RUST_MINIFY_JS, # passes minify_js to minify-html\n STRIP_WHITESPACE_RUST_REMOVE_BANGS, # passes remove_bangs to minify-html\n STRIP_WHITESPACE_RUST_REMOVE_PROCESSING_INSTRUCTIONS, # passes remove_processing_instructions to minify-html\n\nIf you would like to change any of the above variables, simply put them in STRIP_WHITESPACE_CONFIG ( Please note that every variable here is a python boolean ).\n\nFor example:\n\n.. code-block:: python\n \n STRIP_WHITESPACE_CONFIG['STRIP_WHITESPACE_RUST_DO_NOT_MINIFY_DOCTYPE'] = False\n\nPython :\n~~~~~~~~\n\nThe module allows python minifier options to be changed from Flasks's environ variables. If you would like to change any settings, refer to `python-module's <https://github.com/juancarlospaco/css-html-js-minify/blob/master/css_html_js_minify/html_minifier.py/>`_ source code.\n\nThe bindings are ( by default set to a sane value ):\n\n.. code-block:: python\n\n STRIP_WHITESPACE_PYTHON_REMOVE_COMMENTS, # False | removes comments from HTML using python ( not recommended cause rust can do that just fine and fast )\n STRIP_WHITESPACE_PYTHON_CONDENSE_STYLE_FROM_HTML, # True | replaces '<style text/css>' -> '<style>'\n STRIP_WHITESPACE_PYTHON_CONDENSE_SCRIPT_FROM_HTML, # True | replaces '<script text/javascript>' -> '<script>'\n STRIP_WHITESPACE_PYTHON_CLEAN_UNNEEDED_HTML_TAGS, # True | removes some unnecessary tags\n STRIP_WHITESPACE_PYTHON_CONDENSE_HTML_WHITESPACE, # True | This is where the magic happens.\n STRIP_WHITESPACE_PYTHON_UNQUOTE_HTML_ATTRIBUTES, # True | This is also a magic module.\n \n\nIf you would like to change any of the above variables, simply put them in STRIP_WHITESPACE_CONFIG ( Please note that every variable here is a python boolean )\n\nFor example:\n\n.. code-block:: python\n\n STRIP_WHITESPACE_CONFIG['STRIP_WHITESPACE_PYTHON_REMOVE_COMMENTS'] = True\n\nChange Ignored Paths :\n----------------------\n\nThis module allows dynamic ignored path allocation.\nSo for example if your sitemap.xml is at url '/sitemap.xml' and you want to avoid minifying it ( Because this module in lower level is meant to minify HTML not XML ).\nThen you can add it to ignored path. ( By default it ignores '/sitemap.xml' ) \n\nTo customize ignored path:\n\n.. code-block:: python\n \n\n STRIP_WHITESPACE_CONFIG['STRIP_WHITESPACE_MINIFY_IGNORED_PATHS'].append(\"/robots.txt\") # Note that STRIP_WHITESPACE_MINIFY_IGNORED_PATHS is a Python List\n\nChange NBSP Mangle Character :\n------------------------------\n\nThis module first replaces the character from html with a character. \nFor example becomes '\u0985' ( I picked '\u0985' because its a foreign character and not many sites use the character like this '\u0985' ).\nIf for some reason this character is causing problem in your HTML. You can change this from STRIP_WHITESPACE_CONFIG .\n\nTo change mangle character:\n\n.. code-block:: python\n\n\n # Keep the string as short as possible.\n # If you make it long,\n # the python str.replace() method will use more CPU and RAM thus slowing your site down.\n \n STRIP_WHITESPACE_CONFIG[\"STRIP_WHITESPACE_NBSP_MANGLE_CHARACTER\"] = 'ga' # Note that STRIP_WHITESPACE_NBSP_MANGLE_CHARACTER is a python string\n\nChange Compression Settings :\n-----------------------------\nThis module can do the work of compressing response to gzip. ( It can also do brotli, zstd \ud83d\udc40 )\n\nTo change the compression algorithm ( by default using 'gzip' because it's a python stdlib): \n \n.. code-block:: python\n \n # envrion\n\n STRIP_WHITESPACE_CONFIG[\"STRIP_WHITESPACE_COMPRESSION_ALGORITHM\"] = \"gzip\" or \"br\" or \"zstd\" or \"plain\"\n \n\nContributing :\n==============\nIf you like this project add a star. \nIf you have problems or suggestions please put them in the `Issue Tracker <https://github.com/baseplate-admin/flask_strip_whitespace/issues>`__.\nIf you like to add features. Fork this repo and submit a Pull Request. \ud83d\ude1b\n\nUpdates ?? :\n============\nThis repository is freezed. It will automatically install latest `python-strip-whitespace <https://github.com/baseplate-admin/python_strip_whitespace>`_\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A powerful HTML whitespace remover for Flask",
"version": "0.1.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06d937eef7e0fd87428203b0b435ab00b09c4e490022a34eaf00f72f822370e6",
"md5": "f4f6dfb3aafbd8bd67aba1d01f7335f2",
"sha256": "39b82fec1420ab43f4fcbfc67e13bd199e379373de590496d6ce2de1da3ac4d0"
},
"downloads": -1,
"filename": "flask_strip_whitespace-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4f6dfb3aafbd8bd67aba1d01f7335f2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 18174,
"upload_time": "2023-02-01T10:19:20",
"upload_time_iso_8601": "2023-02-01T10:19:20.187066Z",
"url": "https://files.pythonhosted.org/packages/06/d9/37eef7e0fd87428203b0b435ab00b09c4e490022a34eaf00f72f822370e6/flask_strip_whitespace-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "51513c7c088ffaa57b9ce31e8d14cc7ae9ed74d393a66b6dba50334b5ec3e89d",
"md5": "c0e8a460698e2064bac794c451f49cac",
"sha256": "394628753576e62e921887bec8d8c237a60a7a1c3577691a50891989e8e38e4f"
},
"downloads": -1,
"filename": "flask_strip_whitespace-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c0e8a460698e2064bac794c451f49cac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 19193,
"upload_time": "2023-02-01T10:19:21",
"upload_time_iso_8601": "2023-02-01T10:19:21.900426Z",
"url": "https://files.pythonhosted.org/packages/51/51/3c7c088ffaa57b9ce31e8d14cc7ae9ed74d393a66b6dba50334b5ec3e89d/flask_strip_whitespace-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-01 10:19:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "flask-strip-whitespace"
}
