Skip to main content

Inlines external CSS into HTML elements.

Project description

Version:
0.2.3
Download:

http://pypi.python.org/pypi/inlinestyler/

Source:

http://github.com/dlanger/inlinestyler/

Keywords:

inline, HTML, CSS, email, preflight

inlinestyler is an easy way to locally inline CSS into an HTML email message.

Styling HTML email is a black art. CSS works, but only when it’s been placed inline on the individual elements (and event then, not always) - which makes development frustrating, and iteration slow.

The general solution is to use an inlining service, which takes a message with the CSS placed externally, and rewrites it so that all CSS is applied to the individual elements. The most widely used of these services - and as far as I can tell, the one that powers CampaignMonitor - is Premailer. It’s a great service, and the guys behind it put a lot of work into keeping it up to date with the most recent discoveries in what works and what doesn’t.

inlinestyler takes (most) of the functionality of Premailer, and makes it available locally, accessible without having call a remote service.

To see what inline-styler can do, check out this demo.

History

Dave Cranwell wrote the original inline-styler single-app Django project, and (graciously) released it. inlinestyler is a refactor of that project into a free-standing package usable outside of Django.

Requirements

inlinestyler requires the following packages in order to run:

  • cssutils

  • lxml

It also requires a css_complaiance.csv file, which indicates the compatibility of various email clients with certain CSS features. This is included with the package, but can be updated manually from Campaign Monitor’s spreadsheet.

Usage

from inlinestyler.utils import inline_css
message_inline_css = inline_css(message_external_css)

message_external_css must be a string containing the message to be inlined, with the CSS presented in the HTML as one of:

  • an absolute link <link rel="stylesheet" href="http://mysite.com/styles.css" />

  • a <style> block in the <head>, without the use of @import.

The code will also calculate an estimate for how compatible your message is with various clients (using the css_compliance.csv file), but this number isn’t yet exposed.

Contributions

All development happens at github: http://github.com/dlanger/inlinestyler.

To get yourself started:

  1. Clone this repo somewhere

  2. make init to install the right dependencies

  3. make test to run the test suite

Contributions are always more than welcome. If you see something missing, add it in and send me a pull request.

NOTE: Ubuntu 12.04 (and some other distros) include libxslt version 1.1.26, which changes the now-empty <head> tag to <head/> - which isn’t valid HTML 5. To see which version of libxslt was used to build your libxml, examine the output of make init and look for the line that looks like Using build configuration of libxslt 1.1.XX; if that says 26, some test failures are expected (at which point, you can rely on TravisCI to run your tests for you).

You could also install your own version of libxslt from source, but you’re probably going to have a bad time.

License

This distribution is licensed under the New BSD License. Please see the LICENSE file for a full copy of the license text.

As far as I can tell, Dave Cranwell released the underlying inline-styler project into the public domain:

I’m […] releasing it to the public after many requests for the source.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

inlinestyler-0.2.3.tar.gz (16.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

inlinestyler-0.2.3-py2-none-any.whl (16.7 kB view details)

Uploaded Python 2

File details

Details for the file inlinestyler-0.2.3.tar.gz.

File metadata

  • Download URL: inlinestyler-0.2.3.tar.gz
  • Upload date:
  • Size: 16.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for inlinestyler-0.2.3.tar.gz
Algorithm Hash digest
SHA256 250320163ff39753242de35ddc35e6036d85a5fd02de1fc697af2867ddbb09be
MD5 8f78775683e463d0508f0e55bce8ab66
BLAKE2b-256 e40e60c405189fd899a5e84afde8e9eb888f873e39f3a9260a5420d90d569c8b

See more details on using hashes here.

File details

Details for the file inlinestyler-0.2.3-py2-none-any.whl.

File metadata

File hashes

Hashes for inlinestyler-0.2.3-py2-none-any.whl
Algorithm Hash digest
SHA256 ba82a5a8b471c2671b0f98894267a1b3464687a12b32742fb617059f434eecbd
MD5 e4d9796b9fa422eb29e10abb456d4882
BLAKE2b-256 62e52b0a1dab27f7c0f4c94de455e999e6fb81a562dc85ac83d1374093218429

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page