Skip to content

README.rst

Latest commit

 

History

History
105 lines (66 loc) · 2.42 KB

README.rst

File metadata and controls

105 lines (66 loc) · 2.42 KB

libsass: SASS for Python

This package provides a simple Python extension module sass which is binding Libsass (written in C/C++ by Hampton Catlin and Aaron Leung). It's very straightforward and there isn't any headache related Python distribution/deployment. That means you can add just libsass into your setup.py's install_requires list or requirements.txt file.

It currently supports CPython 2.5, 2.6, 2.7, and PyPy 1.9!

Install

Use easy_install or pip:

$ easy_install libsass

Use

>>> import sass
>>> print sass.compile(string='a { b { color: blue; } }')
'a b {\n  color: blue; }\n'

sass.compile()

It takes a source string or a filename and returns the compiled CSS string.

If it fails for any reason (for example the given SASS has broken syntax) it will raise sass.CompileError.

string (required)
The string of SASS source code to compile. It's exclusive to filename parameter.
filename (required)

The filename of SASS source code to compile. It's exclusive to string parameter.

If the file does not exist or cannot be read it will raises exceptions.IOError exception.

output_style (optional)

The coding style of the compiled result. Choose one in:

  • 'nested' (default)
  • 'expanded'
  • 'compact'
  • 'compressed'
include_paths (optional)
The list of paths to find @imported SASS/CSS source files.
image_path (optional)
The path to find images.

sass.CompileError

The exception type that is raised by sass.compile(). It is a subtype of exceptions.ValueError.

Credit

Hong Minhee wrote this Python binding of Libsass.

Hampton Catlin and Aaron Leung wrote Libsass, which is portable C/C++ implementation of SASS.

Hampton Catlin originally designed SASS language and wrote the first reference implementation of it in Ruby.

The above three softwares are all distributed under MIT license.

Changelog

Version 0.1.1

Released on August 18, 2012.

  • Fixed segmentation fault for reading filename which does not exist. Now it raises a proper exceptions.IOError exception.

Version 0.1.0

Released on August 17, 2012. Initial version.