diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..6e7ff2c --- /dev/null +++ b/README.rst @@ -0,0 +1,48 @@ +PyKSS - Knyle Style Sheets +========================== + +PyKSS is a Python implementation of KSS_. KSS attempts to provide a +methodology for writing maintainable, documented CSS within a team. + +The official docs_ provide a good introduction to KSS. The complete +syntax can he found on the syntax_ page. + +.. _KSS: http://warpspire.com/kss +.. _docs: http://warpspire.com/kss/ +.. _syntax: http://warpspire.com/kss/syntax/ + + +Installing +---------- + +.. code-block:: shell + + pip install pykss + + +Usage +----- + +.. code-block:: python + + >>> import pykss + >>> + >>> styleguide = pykss.Parser('static/css') + >>> + >>> styleguide.section('2.1.1') + <pykss.section.Section object at 0x10c1d1190> + >>> + >>> styleguide.section('2.1.1').description + 'A button suitable for giving stars to someone.' + >>> + >>> styleguide.section('2.1.1').modifiers[0] + <pykss.modifier.Modifier object at 0x10c1d1290> + >>> + >>> styleguide.section('2.1.1').modifiers[0].name + ':hover' + >>> + >>> styleguide.section('2.1.1').modifiers[0].class_name + 'pseudo-class-hover' + >>> + >>> styleguide.section('2.1.1').modifiers[0].description + 'Subtle hover highlight' |