Skip to content

Latest commit

 

History

History
111 lines (74 loc) · 2.89 KB

README.rst

File metadata and controls

111 lines (74 loc) · 2.89 KB
Raw

libsass-python: Sass/SCSS for Python

PyPI Build Status pre-commit.ci status

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 to Python distribution/deployment. That means you can add just libsass into your setup.py's install_requires list or requirements.txt file. No need for Ruby nor Node.js.

Features

  • You don't need any Ruby/Node.js stack at all, for development or deployment either.
  • Fast. (LibSass is written in C++.)
  • Simple API. See the below example code for details.
  • Custom functions.
  • @import callbacks.
  • Support both tabbed (Sass) and braces (SCSS) syntax.
  • WSGI middleware for ease of development. It automatically compiles Sass/SCSS files for each request.
  • setuptools/distutils integration. You can build all Sass/SCSS files using setup.py build_sass command.
  • Works also on PyPy.
  • Provides prebuilt wheel binaries for Linux, Windows, and Mac.

Install

It's available on PyPI, so you can install it using pip (or easy_install):

$ pip install libsass

Note

libsass requires some features introduced by the recent C++ standard. You need a C++ compiler that support those features. See also libsass project's README file.

Example

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

Docs

There's the user guide manual and the full API reference for libsass:

https://sass.github.io/libsass-python/

You can build the docs by yourself:

$ cd docs/
$ make html

The built docs will go to docs/_build/html/ directory.

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 are all distributed under MIT license.