Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davecranwell/inline-styler
Creates HTML emails with maximal CSS compatibility by inlining external CSS files.
https://github.com/davecranwell/inline-styler
Last synced: 15 days ago
JSON representation
Creates HTML emails with maximal CSS compatibility by inlining external CSS files.
- Host: GitHub
- URL: https://github.com/davecranwell/inline-styler
- Owner: davecranwell
- Created: 2011-08-26T13:58:31.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2019-03-21T09:09:31.000Z (over 5 years ago)
- Last Synced: 2024-08-10T14:15:29.502Z (4 months ago)
- Language: Python
- Homepage:
- Size: 60.5 KB
- Stars: 207
- Watchers: 18
- Forks: 52
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Inline Styler makes CSS compatible with email clients.
It's a service which, when given a block of HTML including CSS, will parse the CSS and convert it to inline `style=""` attributes on each elements matched by the CSS rules found.
The benefit of this is primarily in developing HTML emails. The most common email clients have patchy support for `` or `<link>` elements, but do on the whole support a varied set of CSS properties. Its therefore necessary to instead define styles in "style" attributes on each of the elements themselves, which is tedious for anything but the simplest of emails and introduces significant code maintenance problems. The Inline Styler frees up the developer to write CSS in less tedious/more maintainable ways: using proper selectors and rules, grouped in either a stylesheet or a `<style>` block. The Inline Styler converts these rules into the inline "style" attributes for you.
Additionally, among the email clients who do support CSS, support for individual CSS properties is variable. The Inline Styler will analyse your CSS and estimate a compatibility rating across all the email clients as a whole, alerting you to any particular properties likely to reduce compatibility.
## Usage
To use this app, CSS you wish to be "inlined" must be declared in the HTML either:
- linked absolutely e.g `<link rel="stylesheet" href="http://mysite.com/styles.css" />` or
- provided in a `<style>` block in the `<head>` of the HTML, without `@imports`
## Self-hosting requirements
- lxml: http://lxml.de/
- cssutils: http://pypi.python.org/pypi/cssutils
- `css_compliance.csv` generated by hand from the "complete guide" Excel spreadsheet from Campaign Monitor: http://www.campaignmonitor.com/css/.
This file requires periodic updates as Campaign Monitor update their spreadsheet. Comparing the existing file to CM's spreadsheet, the key differences are that their XLS has been stripped of formatting, blank lines or duplicate groups of selector/element information.
## Support
Inline Styler was written several years ago partly as a personal "Hello World" experiment to learn Django/Python. I welcome anyone willing to fork and contribute to the code, but unfortunately I don't have time to maintain this myself - for example updating the css compliance CSV. I'm instead releasing it to the public after many requests for the source.
## Questions/Discussion
* Find me on twitter at @davecranwell