Metadata-Version: 2.1
Name: css_inline
Version: 0.2.0
Summary: Fast CSS inlining written in Rust
Home-page: https://github.com/Stranger6667/css-inline/tree/master/python
Author: Dmitry Dygalo
Author-email: dadygalo@gmail.com
Maintainer: Dmitry Dygalo
Maintainer-email: dadygalo@gmail.com
License: MIT
Description: css_inline
        ==========
        
        |Build| |Version| |Python versions| |License|
        
        Fast CSS inlining for Python implemented in Rust.
        
        Features:
        
        - Removing ``style`` tags after inlining;
        - Resolving external stylesheets (including local files);
        - ... more features will be available soon
        
        **NOTE**. This library is in active development and provides a small number of features at the moment, see ``Limitations`` sections below for more information.
        
        Installation
        ------------
        
        To install ``css_inline`` via ``pip`` run the following command:
        
        .. code:: bash
        
            pip install css_inline
        
        Usage
        -----
        
        To inline CSS in a HTML document:
        
        .. code:: python
        
            import css_inline
        
            HTML = """<html>
            <head>
                <title>Test</title>
                <style>h1 { color:blue; }</style>
            </head>
            <body>
                <h1>Big Text</h1>
            </body>
            </html>"""
        
            inlined = css_inline.inline(HTML)
        
        If you want to inline many HTML documents then you can utilize ``inline_many`` that processes the input in parallel.
        
        .. code:: python
        
            import css_inline
        
            css_inline.inline_many(["...", "..."])
        
        For customization options use ``CSSInliner`` class:
        
        .. code:: python
        
            import css_inline
        
            inliner = css_inline.CSSInliner(remove_style_tags=True)
            inliner.inline("...")
        
        Performance
        -----------
        
        Due to the usage of efficient tooling from Mozilla's Servo project (``html5ever``, ``rust-cssparser`` and others) this
        library has good performance characteristics. In comparison with other Python projects, it is ~12-15x faster than the nearest competitor.
        
        For inlining CSS in the html document from the ``Usage`` section above we have the following breakdown in our benchmarks:
        
        - ``css_inline 0.2.0`` - 24.47 us
        - ``premailer 3.7.0`` - 345.47 us (**x14.11**)
        - ``inlinestyler 0.2.4`` - 2.47 ms (**x101.03**)
        - ``pynliner 0.8.0`` - 2.82 ms (**x115.53**)
        
        You can take a look at the benchmarks' code at ``benches/bench.py`` file.
        The results above were measured with ``rustc 1.46``, ``Python 3.8`` on i8700K, and 32GB RAM.
        
        Limitations
        -----------
        
        Currently (as of ``0.2.0``) there are the following notable limitations:
        
        - Inlined CSS is not minimized (`#12 <https://github.com/Stranger6667/css-inline/issues/12>`_)
        - `class` and `id` attributes are not removed (`#13 <https://github.com/Stranger6667/css-inline/issues/13>`_)
        
        Python support
        --------------
        
        ``css_inline`` supports Python 3.5, 3.6, 3.7, and 3.8.
        
        License
        -------
        
        The code in this project is licensed under `MIT license`_.
        By contributing to ``css_inline``, you agree that your contributions
        will be licensed under its MIT license.
        
        .. |Build| image:: https://github.com/Stranger6667/css-inline/workflows/ci/badge.svg
           :target: https://github.com/Stranger6667/css_inline/actions
        .. |Version| image:: https://img.shields.io/pypi/v/css_inline.svg
           :target: https://pypi.org/project/css_inline/
        .. |Python versions| image:: https://img.shields.io/pypi/pyversions/css_inline.svg
           :target: https://pypi.org/project/css_inline/
        .. |License| image:: https://img.shields.io/pypi/l/css_inline.svg
           :target: https://opensource.org/licenses/MIT
        
        .. _MIT license: https://opensource.org/licenses/MIT
        
Keywords: css inline html rust
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Rust
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
