summaryrefslogtreecommitdiff
path: root/README.rst
blob: 4457f8fe6c3e58ec2c6b6f872759232833a1e5eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
pyScss, a Scss compiler for Python
==================================

|build-status| |coverage|

.. |build-status| image:: https://travis-ci.org/Kronuz/pyScss.svg?branch=master
    :target: https://travis-ci.org/Kronuz/pyScss

.. |coverage| image:: https://coveralls.io/repos/Kronuz/pyScss/badge.png
    :target: https://coveralls.io/r/Kronuz/pyScss

pyScss is a compiler for the `Sass`_ language, a superset of CSS3 that adds
programming capabilities and some other syntactic sugar.

.. _Sass: http://sass-lang.com/

Quickstart
----------

You need Python 2.6+ or 3.3+.  PyPy is also supported.

Installation::

    pip install pyScss

Usage::

    python -mscss < style.scss

Python API::

    from scss import Compiler
    Compiler().compile_string("a { color: red + green; }")


Features
--------

95% of Sass 3.2 is supported.  If it's not supported, it's a bug!  Please file
a ticket.

Most of Compass 0.11 is also built in.


Further reading
---------------

Documentation is in Sphinx.  You can build it yourself by running ``make html``
from within the ``docs`` directory, or read it on RTD:
http://pyscss.readthedocs.org/en/latest/

The canonical syntax reference is part of the Ruby Sass documentation:
http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html


Obligatory
----------

Copyright © 2012 German M. Bravo (Kronuz).  Additional credits in the
documentation.

Licensed under the `MIT license`_, reproduced in ``LICENSE``.

.. _MIT license: http://www.opensource.org/licenses/mit-license.php