first

faruken · faruken · commit 7be2596e9779 · 2012-02-08T13:01:23.000+11:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+.DS_Store
+*.pyc
+dist
+*.egg
+*.egg-info
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) 2012, Faruk Akgul.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. All advertising materials mentioning features or use of this software
+   must display the following acknowledgement:
+   This product includes software developed by the contributors.
+4. Neither the name of the contributors nor the
+   names of its contributors may be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ''AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+include LICENSE
diff --git a/README.md b/README.md
@@ -0,0 +1,34 @@
+#LessCSS
+
+LessCSS is a helper which automatically compiles LESS files to CSS whenever the LESS files are modified.
+
+It works with Brubeck and web.py web frameworks. Although it's not tested on other frameworks such as bottle, it should work without any problems.
+
+Sample Brubeck and web.py projects are in `examples` folder.
+
+**Note:** You need to install `less` before using this helper.
+
+##Installation
+
+`$ pip -U install lesscss`
+
+##Usage
+
+	from lesscss.lesscss import LessCSS
+	LessCSS(media_dir='media', exclude_dirs=['img', 'js'], based=True)
+
+###Parameters
+
+- **media_dir**: Directory where you put static/media files such as css/js/img.
+- **exclude_dirs**: Directories you don't want to be searched. It'd be pointless to search for `less` files in an images directory. This parameter is expected to be a list.
+- **based**: If it's set `True` then LessCSS will generate the `style-(base60).css` version as well (for example; `style-dHCFD.css`). This is useful if you set expire times of static files to a distant future since browsers will not retrieve those files unless the name is different or the cache has expired. This parameter is expected to be a boolean value.
+	
+
+##TODO
+- Automatically set CSS name in HTML templates.
+
+#LICENSE
+Released under BSD, see LICENSE for details.
+
+##Else
+Code is based on Steve Losh's [flask-lesscss](http://sjl.bitbucket.org/flask-lesscss/).
diff --git a/examples/brubeck/main.py b/examples/brubeck/main.py
@@ -0,0 +1,30 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import logging
+from brubeck.templating import load_jinja2_env
+from brubeck.request_handling import Brubeck
+from brubeck.templating import Jinja2Rendering
+
+
+class IndexHandler(Jinja2Rendering):
+  def get(self):
+    return self.render_template('index.html')
+
+
+config = {
+  'mongrel2_pair': ('ipc://127.0.0.1:9999', 'ipc://127.0.0.1:9998'),
+  'handler_tuples': [(r'^/$', IndexHandler)],
+  'log_level': logging.DEBUG,
+  'template_loader': load_jinja2_env('templates'),
+}
+
+app = Brubeck(**config)
+
+if __name__ == '__main__':
+  DEBUG = True
+  if DEBUG:
+    from lesscss import LessCSS
+    LessCSS(media_dir='static', exclude_dirs=['.fr'], based=False)
+
+  app.run()
diff --git a/examples/brubeck/static/css/style.less b/examples/brubeck/static/css/style.less
@@ -0,0 +1,20 @@
+@base: #333;
+
+body {
+  font-family:arial, sans-serif;
+  color: @base;
+}
+
+.box-shadow(@style, @c) when (iscolor(@c)) {
+  box-shadow:         @style @c;
+  -webkit-box-shadow: @style @c;
+  -moz-box-shadow:    @style @c;
+}
+.box-shadow(@style, @alpha: 50%) when (isnumber(@alpha)) {
+  .box-shadow(@style, rgba(0, 0, 0, @alpha));
+}
+.box { 
+  color: saturate(@base, 5%);
+  border-color: lighten(@base, 30%);
+  div { .box-shadow(0 0 5px, 30%) }
+}
diff --git a/examples/brubeck/templates/index.html b/examples/brubeck/templates/index.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="utf-8">
+	<title>Brubeck LessCSS</title>
+  <link rel="stylesheet" type="text/css" href="/static/css/style.css" />
+</head>
+<body>
+  <header><h1 class="box">Brubeck LessCSS</h1></header>
+  
+  <section class="box">
+      <div>Testing, attention please...</div>
+  </section>
+
+  <footer>Seven dwarfs and Snow White.</footer>
+</body>
+</html>
diff --git a/examples/webpy/main.py b/examples/webpy/main.py
@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import web
+
+render = web.template.render('templates')
+
+class Index(object):
+  def GET(self):
+    return render.index()
+
+DEBUG = True
+web.config.debug = DEBUG
+app = web.application((r'^/', 'Index'), globals(), autoreload=True)
+
+if __name__ == '__main__':
+  if DEBUG:
+    from lesscss.lesscss import LessCSS
+    LessCSS()
+  app.run()
diff --git a/examples/webpy/static/css/style.less b/examples/webpy/static/css/style.less
@@ -0,0 +1,20 @@
+@base: #333;
+
+body {
+  font-family:arial, sans-serif;
+  color: @base;
+}
+
+.box-shadow(@style, @c) when (iscolor(@c)) {
+  box-shadow:         @style @c;
+  -webkit-box-shadow: @style @c;
+  -moz-box-shadow:    @style @c;
+}
+.box-shadow(@style, @alpha: 50%) when (isnumber(@alpha)) {
+  .box-shadow(@style, rgba(0, 0, 0, @alpha));
+}
+.box { 
+  color: saturate(@base, 5%);
+  border-color: lighten(@base, 30%);
+  div { .box-shadow(0 0 5px, 30%) }
+}
diff --git a/examples/webpy/templates/index.html b/examples/webpy/templates/index.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="utf-8">
+	<title>web.py LessCSS</title>
+  <link rel="stylesheet" type="text/css" href="/static/css/style.css" />
+</head>
+<body>
+  <header><h1 class="box">web.py LessCSS</h1></header>
+  
+  <section class="box">
+      <div>Testing, attention please...</div>
+  </section>
+
+  <footer>Seven dwarfs and Snow White.</footer>
+</body>
+</html>
diff --git a/lesscss/__init__.py b/lesscss/__init__.py
@@ -0,0 +1,26 @@
+__version__ = '0.1'
+__doc__ = """
+
+About
+=====
+
+LessCSS is a helper which automatically compiles LESS files to CSS when LESS
+files are modified. It works with Brubeck and web.py web frameworks. Although
+it's not tested on other frameworks such as bottle, it should work without any
+problems.
+
+
+Installation
+============
+
+::
+$ pip install lesscss
+
+
+
+Links
+=====
+
+* `Developer Release <http://github.com/faruken/lesscss>`_
+
+"""
diff --git a/lesscss/lesscss.py b/lesscss/lesscss.py
@@ -0,0 +1,108 @@
+# -*- coding: utf-8 -*-
+"""
+    lesscss
+    ~~~~~~~
+    A small helper which automatically compiles LESS files to CSS when you
+    modify LESS files of your project.
+
+    :copyright: (c) 2012 Faruk Akgul.
+    :license: BSD, see LICENSE for more details.
+"""
+
+import os
+import re
+import subprocess
+from uuid import uuid4
+
+
+class LessCSS(object):
+
+    """LessCSS is a helper which automatically compiles LESS files to CSS when
+    the LESS files are modified. It works with Brubeck and web.py web
+    frameworks. Although it's not tested on other frameworks such as bottle,
+    it should work without any problems.
+
+    Sample Brubeck and web.py projects are in `examples` folder.
+    """
+
+    def __init__(self, media_dir='static', exclude_dirs=None, based=True):
+        """ Initialize LessCSS. When you wrap your web application you need to
+        define the following parameters:
+
+        ``media_dir``
+            Define the absolute path of the folder where you put all your
+            static files such as css/js.
+
+        ``exclude_dirs``
+            If you don't want certain folders to be checked (such as a folder
+            where you put your image and javascript files), put folder names
+            into the list. LessCSS will not check those folders.
+
+        ``based``
+            If this is set to `True`, then LessCSS will generate
+            `style-base.css` as well (for example; `style-dHCFD.css`). This is
+            useful if you set expire times of static files for a long time
+            since browsers will not retrieve those files unless the name is
+            different or the cache has expired.
+        """
+        self._media = media_dir
+        self._based = based
+        self._excluded = exclude_dirs
+        self.compile()
+
+    @classmethod
+    def to60(cls, val):
+        """Base60 generator.
+
+        ``val``
+            Parameter which its base64 value is generated. This is expected to
+            be an integer.
+
+        """
+        CHARS = '0123456789ABCDEFGHJKLMNPQRSTUVWXYZ_abcdefghijkmnopqrstuvwxyz'
+        LEN = len(CHARS)
+        l = []
+        while val > 0:
+            val, rem = divmod(val, LEN)
+            l.insert(0, CHARS[rem])
+        return ''.join(l)
+
+    def get_less(self):
+        """Walks through subdirectories and puts LESS files into a list.
+        """
+        media_dir = self._media
+        less = []
+        REGEX = re.compile(r'^.*[.](?P<ext>less|\w+)$', re.I)
+        for root, dirs, files in os.walk(media_dir):
+            if self._excluded is not None and isinstance(self._excluded, list):
+                [dirs.remove(exclude)
+                                        for exclude in self._excluded
+                                        if exclude in dirs]
+            less.extend([
+                            os.path.join(root, i)
+                            for i in files
+                            if REGEX.match(i).group('ext') == 'less'
+                        ])
+        return less
+
+    def compile(self):
+        """Compiles LESS files to CSS if necessary. It does it by checking
+        the last modified time. If `based` is `True` then base60 filename of
+        LESS file is generated as well.
+
+        #TODO: Automatically set CSS name in HTML templates.
+        """
+        less = self.get_less()
+        for i in less:
+            filename = os.path.splitext(i)[0]
+            css = '%s.css' % filename
+            css_time = -1  # Poor man's Integer.MIN_VALUE
+            if os.path.isfile(css):
+                css_time = os.path.getmtime(css)
+            less_time = os.path.getmtime(i)
+            if less_time >= css_time:
+                subprocess.call(['lessc', i, css], shell=False)
+                if self._based:
+                    css_based = '%s-%s.css' % (filename,
+                                                LessCSS.to60(uuid4().time_low))
+                    subprocess.call(['lessc', i, css_based], shell=False)
diff --git a/setup.py b/setup.py
@@ -0,0 +1,35 @@
+"""
+
+lesscss
+
+"""
+
+from setuptools import (setup, find_packages)
+from lesscss import (__version__, __doc__)
+
+setup(
+
+    name='lesscss',
+    version=__version__,
+    url='http://github.com/faruken/lesscss',
+    license='BSD',
+    author='Faruk Akgul',
+    author_email='me@akgul.org',
+    description='A helper which automatically compiles LESS files to CSS.',
+    long_description=__doc__,
+    zip_safe=False,
+    packages=find_packages(exclude=['examples']),
+    platforms='any',
+    classifiers=[
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2.5',
+        'Programming Language :: Python :: 2.6',
+        'Programming Language :: Python :: 2.7',
+        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+    ],
+)

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +.DS_Store
 +*.pyc
 +dist
 +*.egg
 +*.egg-info