Turns CSS blocks into style attributes
Project description
premailer
=========
[](https://travis-ci.org/peterbe/premailer)
[](https://coveralls.io/r/peterbe/premailer?branch=master)
Looking for sponsors
--------------------
This project is actively looking for corporate sponsorship.
If you want to help making this an active project consider
[pinging Peter](http://www.peterbe.com/contact) and we can talk about putting up
logos and links to your company.
Python versions
---------------
Our [tox.ini](https://github.com/peterbe/premailer/blob/master/tox.ini) makes sure premailer works in:
* Python 2.6
* Python 2.7
* Python 3.2
* Python 3.3
* Python 3.4
* PyPy
Turns CSS blocks into style attributes
--------------------------------------
When you send HTML emails you can't use style tags but instead you
have to put inline `style` attributes on every element. So from this:
```html
<html>
<style type="text/css">
h1 { border:1px solid black }
p { color:red;}
</style>
<h1 style="font-weight:bolder">Peter</h1>
<p>Hej</p>
</html>
```
You want this:
```html
<html>
<h1 style="font-weight:bolder; border:1px solid black">Peter</h1>
<p style="color:red">Hej</p>
</html>
```
premailer does this. It parses an HTML page, looks up `style` blocks
and parses the CSS. It then uses the `lxml.html` parser to modify the
DOM tree of the page accordingly.
Getting started
---------------
If you haven't already done so, install `premailer` first:
$ pip install premailer
Next, the most basic use is to use the shortcut function, like this:
>>> from premailer import transform
>>> print transform("""
... <html>
... <style type="text/css">
... h1 { border:1px solid black }
... p { color:red;}
... p::first-letter { float:left; }
... </style>
... <h1 style="font-weight:bolder">Peter</h1>
... <p>Hej</p>
... </html>
... """)
<html>
<head></head>
<body>
<h1 style="font-weight:bolder; border:1px solid black">Peter</h1>
<p style="color:red">Hej</p>
</body>
</html>
For more advanced options, check out the code of the `Premailer` class
and all its options in its constructor.
You can also use premailer from the command line by using his main module.
$ python -m premailer -h
usage: python -m premailer [options]
optional arguments:
-h, --help show this help message and exit
-f [INFILE], --file [INFILE]
Specifies the input file. The default is stdin.
-o [OUTFILE], --output [OUTFILE]
Specifies the output file. The default is stdout.
--base-url BASE_URL
--remove-internal-links PRESERVE_INTERNAL_LINKS
Remove links that start with a '#' like anchors.
--exclude-pseudoclasses
Pseudo classes like p:last-child', p:first-child, etc
--preserve-style-tags
Do not delete <style></style> tags from the html
document.
--remove-star-selectors
All wildcard selectors like '* {color: black}' will be
removed.
--remove-classes Remove all class attributes from all elements
--strip-important Remove '!important' for all css declarations.
--method METHOD The type of html to output. 'html' for HTML, 'xml' for
XHTML.
--base-path BASE_PATH
The base path for all external stylsheets.
--external-style EXTERNAL_STYLES
The path to an external stylesheet to be loaded.
--disable-basic-attributes DISABLE_BASIC_ATTRIBUTES
Disable provided basic attributes (comma separated)
--disable-validation Disable CSSParser validation of attributes and values
--pretty Pretty-print the outputted HTML.
A basic example:
$ python -m premailer --base-url=http://google.com/ -f newsletter.html
<html>
<head><style>.heading { color:red; }</style></head>
<body><h1 class="heading" style="color:red"><a href="http://google.com/">Title</a></h1></body>
</html>
The command line interface supports standard input.
$ echo '<style>.heading { color:red; }</style><h1 class="heading"><a href="/">Title</a></h1>' | python -m premailer --base-url=http://google.com/
<html>
<head><style>.heading { color:red; }</style></head>
<body><h1 class="heading" style="color:red"><a href="http://google.com/">Title</a></h1></body>
</html>
Turning relative URLs into absolute URLs
----------------------------------------
Another thing premailer can do for you is to turn relative URLs (e.g.
"/some/page.html" into "http://www.peterbe.com/some/page.html"). It
does this to all `href` and `src` attributes that don't have a `://`
part in it. For example, turning this:
```html
<html>
<body>
<a href="/">Home</a>
<a href="page.html">Page</a>
<a href="http://crosstips.org">External</a>
<img src="/folder/">Folder</a>
</body>
</html>
```
Into this:
```html
<html>
<body>
<a href="http://www.peterbe.com/">Home</a>
<a href="http://www.peterbe.com/page.html">Page</a>
<a href="http://crosstips.org">External</a>
<img src="http://www.peterbe.com/folder/">Folder</a>
</body>
</html>
```
by using `transform('...', base_url='http://www.peterbe.com/')`.
Ignore certain `<style>` or `<link>` tags
-----------------------------------------
Suppose you have a style tag that you don't want to have processed and
transformed you can simply set a data attribute on the tag like:
```html
<head>
<style>/* this gets processed */</style>
<style data-premailer="ignore">/* this gets ignored */</style>
</head>
```
That tag gets completely ignored except when the HTML is processed, the
attribute `data-premailer` is removed.
It works equally for a `<link>` tag like:
```html
<head>
<link rel="stylesheet" href="foo.css" data-premailer="ignore">
</head>
```
HTML attributes created additionally
------------------------------------
Certain HTML attributes are also created on the HTML if the CSS
contains any ones that are easily translated into HTML attributes. For
example, if you have this CSS: `td { background-color:#eee; }` then
this is transformed into `style="background-color:#eee"` AND as an
HTML attribute `bgcolor="#eee"`.
Having these extra attributes basically as a "back up" for really shit
email clients that can't even take the style attributes. A lot of
professional HTML newsletters such as Amazon's use this.
You can disable some attributes in `disable_basic_attributes`
Running tests with tox
----------------------
To run `tox` you don't need to have all available Python versions installed because it will only work on those you have. To use `tox` first install it:
pip install tox
Then simply start it with:
tox
Donations aka. the tip jar
--------------------------
If you enjoy, benefit and want premailer to continue to be an actively
maintained project please consider supporting me on [Gratipay](https://gratipay.com/peterbe/).
[](https://gratipay.com/peterbe/)
=========
[](https://travis-ci.org/peterbe/premailer)
[](https://coveralls.io/r/peterbe/premailer?branch=master)
Looking for sponsors
--------------------
This project is actively looking for corporate sponsorship.
If you want to help making this an active project consider
[pinging Peter](http://www.peterbe.com/contact) and we can talk about putting up
logos and links to your company.
Python versions
---------------
Our [tox.ini](https://github.com/peterbe/premailer/blob/master/tox.ini) makes sure premailer works in:
* Python 2.6
* Python 2.7
* Python 3.2
* Python 3.3
* Python 3.4
* PyPy
Turns CSS blocks into style attributes
--------------------------------------
When you send HTML emails you can't use style tags but instead you
have to put inline `style` attributes on every element. So from this:
```html
<html>
<style type="text/css">
h1 { border:1px solid black }
p { color:red;}
</style>
<h1 style="font-weight:bolder">Peter</h1>
<p>Hej</p>
</html>
```
You want this:
```html
<html>
<h1 style="font-weight:bolder; border:1px solid black">Peter</h1>
<p style="color:red">Hej</p>
</html>
```
premailer does this. It parses an HTML page, looks up `style` blocks
and parses the CSS. It then uses the `lxml.html` parser to modify the
DOM tree of the page accordingly.
Getting started
---------------
If you haven't already done so, install `premailer` first:
$ pip install premailer
Next, the most basic use is to use the shortcut function, like this:
>>> from premailer import transform
>>> print transform("""
... <html>
... <style type="text/css">
... h1 { border:1px solid black }
... p { color:red;}
... p::first-letter { float:left; }
... </style>
... <h1 style="font-weight:bolder">Peter</h1>
... <p>Hej</p>
... </html>
... """)
<html>
<head></head>
<body>
<h1 style="font-weight:bolder; border:1px solid black">Peter</h1>
<p style="color:red">Hej</p>
</body>
</html>
For more advanced options, check out the code of the `Premailer` class
and all its options in its constructor.
You can also use premailer from the command line by using his main module.
$ python -m premailer -h
usage: python -m premailer [options]
optional arguments:
-h, --help show this help message and exit
-f [INFILE], --file [INFILE]
Specifies the input file. The default is stdin.
-o [OUTFILE], --output [OUTFILE]
Specifies the output file. The default is stdout.
--base-url BASE_URL
--remove-internal-links PRESERVE_INTERNAL_LINKS
Remove links that start with a '#' like anchors.
--exclude-pseudoclasses
Pseudo classes like p:last-child', p:first-child, etc
--preserve-style-tags
Do not delete <style></style> tags from the html
document.
--remove-star-selectors
All wildcard selectors like '* {color: black}' will be
removed.
--remove-classes Remove all class attributes from all elements
--strip-important Remove '!important' for all css declarations.
--method METHOD The type of html to output. 'html' for HTML, 'xml' for
XHTML.
--base-path BASE_PATH
The base path for all external stylsheets.
--external-style EXTERNAL_STYLES
The path to an external stylesheet to be loaded.
--disable-basic-attributes DISABLE_BASIC_ATTRIBUTES
Disable provided basic attributes (comma separated)
--disable-validation Disable CSSParser validation of attributes and values
--pretty Pretty-print the outputted HTML.
A basic example:
$ python -m premailer --base-url=http://google.com/ -f newsletter.html
<html>
<head><style>.heading { color:red; }</style></head>
<body><h1 class="heading" style="color:red"><a href="http://google.com/">Title</a></h1></body>
</html>
The command line interface supports standard input.
$ echo '<style>.heading { color:red; }</style><h1 class="heading"><a href="/">Title</a></h1>' | python -m premailer --base-url=http://google.com/
<html>
<head><style>.heading { color:red; }</style></head>
<body><h1 class="heading" style="color:red"><a href="http://google.com/">Title</a></h1></body>
</html>
Turning relative URLs into absolute URLs
----------------------------------------
Another thing premailer can do for you is to turn relative URLs (e.g.
"/some/page.html" into "http://www.peterbe.com/some/page.html"). It
does this to all `href` and `src` attributes that don't have a `://`
part in it. For example, turning this:
```html
<html>
<body>
<a href="/">Home</a>
<a href="page.html">Page</a>
<a href="http://crosstips.org">External</a>
<img src="/folder/">Folder</a>
</body>
</html>
```
Into this:
```html
<html>
<body>
<a href="http://www.peterbe.com/">Home</a>
<a href="http://www.peterbe.com/page.html">Page</a>
<a href="http://crosstips.org">External</a>
<img src="http://www.peterbe.com/folder/">Folder</a>
</body>
</html>
```
by using `transform('...', base_url='http://www.peterbe.com/')`.
Ignore certain `<style>` or `<link>` tags
-----------------------------------------
Suppose you have a style tag that you don't want to have processed and
transformed you can simply set a data attribute on the tag like:
```html
<head>
<style>/* this gets processed */</style>
<style data-premailer="ignore">/* this gets ignored */</style>
</head>
```
That tag gets completely ignored except when the HTML is processed, the
attribute `data-premailer` is removed.
It works equally for a `<link>` tag like:
```html
<head>
<link rel="stylesheet" href="foo.css" data-premailer="ignore">
</head>
```
HTML attributes created additionally
------------------------------------
Certain HTML attributes are also created on the HTML if the CSS
contains any ones that are easily translated into HTML attributes. For
example, if you have this CSS: `td { background-color:#eee; }` then
this is transformed into `style="background-color:#eee"` AND as an
HTML attribute `bgcolor="#eee"`.
Having these extra attributes basically as a "back up" for really shit
email clients that can't even take the style attributes. A lot of
professional HTML newsletters such as Amazon's use this.
You can disable some attributes in `disable_basic_attributes`
Running tests with tox
----------------------
To run `tox` you don't need to have all available Python versions installed because it will only work on those you have. To use `tox` first install it:
pip install tox
Then simply start it with:
tox
Donations aka. the tip jar
--------------------------
If you enjoy, benefit and want premailer to continue to be an actively
maintained project please consider supporting me on [Gratipay](https://gratipay.com/peterbe/).
[](https://gratipay.com/peterbe/)
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
premailer-2.8.3.tar.gz
(14.3 kB
view details)
Built Distribution
premailer-2.8.3-py2-none-any.whl
(17.5 kB
view details)
File details
Details for the file premailer-2.8.3.tar.gz.
File metadata
- Download URL: premailer-2.8.3.tar.gz
- Upload date:
- Size: 14.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
025ac5d51395f7ac65964207ad3f2383e2303db57f7bb5ee18af84dad5b58f1a
|
|
| MD5 |
3a0aec92f688a8e0209a7fe5711b4f76
|
|
| BLAKE2b-256 |
24e2e484706cc953d9714d13de5bab882f6c3bff8e4ec3304f995e697d1221a3
|
File details
Details for the file premailer-2.8.3-py2-none-any.whl.
File metadata
- Download URL: premailer-2.8.3-py2-none-any.whl
- Upload date:
- Size: 17.5 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4d14fabf8e11fb4c798ca51a5c9513de92cf6332552adad66890f5264ca65256
|
|
| MD5 |
dcaed1cfeb015253f1be2bd4c2bbf2eb
|
|
| BLAKE2b-256 |
0b555f66388531e6a430adcbcd7f387b94beaa12664623af765769bb939ff09d
|
