Task executioner similar to gulp for Python
Project description
# Flask-Gulp
Task manager similar to [gulp](URL) for the processing of static files.
## Working with Flask-Gulp
Setting up Flask-Gulp is quite easy. Here is an example:
```python
from flask_gulp import Static
static = Static(app)
```
This allows to add tasks with the `task` decorator:
```python
@static.task('coffee')
def coffee_task():
src(r'static/coffee/**/*.coffee')\
.pipe(coffee(bare=True))\
.pipe(dest(output='static/js/'))
```
The `src` function is provided as a global to the task function scope along with all the extensions.
As you can see, the workflow is similar to [gulp](URL).
## The `js` and `css` functions
Inspired by [Flask-Funnel](URL), the `js` and `css` functions are provided to the application context in order to generate the corresponding links:
```html+jinja
<head>
<!-- ... -->
{{ css('less') }}
</head>
<body>
<!-- ... -->
{{ js('coffee', 'cjsx') }}
</body>
```
Each one receives multiple tasks names and generate the links to the generated files.
## Extensions
Flask-Gulp comes shiped with four extensions, `coffee`, `cjsx`, `less` and `dest`. The first ones accept an `executable` setting, which holds the corresponding binary location, the default is to call it directly.
To add new extensions use the decorator provided with Flask-Gulp:
```python
from flask_gulp.extensions import extension
@extension
def cjsx(resources):
command = ['cjsx', '-c', '-s']
bare = cjsx.settings.get('bare')
if bare:
command += ['-b']
for filename, data in resources:
process = subprocess.Popen(command,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
out, err = process.communicate(data)
if process.returncode:
yield None, err
else:
dest = replaceExt(filename, '.js')
yield dest, out
```
Each extension receive an iterable object which yields the name and content of each file. The function must return an iterable object with the same format for resulting files. Returning the new file name as `None` will be interpreted as an error.
The variable `<function_name>.settings` holds a dictionary with the keywords provided in the extension initialization, for instance `cjsx(bare=True)`.
Task manager similar to [gulp](URL) for the processing of static files.
## Working with Flask-Gulp
Setting up Flask-Gulp is quite easy. Here is an example:
```python
from flask_gulp import Static
static = Static(app)
```
This allows to add tasks with the `task` decorator:
```python
@static.task('coffee')
def coffee_task():
src(r'static/coffee/**/*.coffee')\
.pipe(coffee(bare=True))\
.pipe(dest(output='static/js/'))
```
The `src` function is provided as a global to the task function scope along with all the extensions.
As you can see, the workflow is similar to [gulp](URL).
## The `js` and `css` functions
Inspired by [Flask-Funnel](URL), the `js` and `css` functions are provided to the application context in order to generate the corresponding links:
```html+jinja
<head>
<!-- ... -->
{{ css('less') }}
</head>
<body>
<!-- ... -->
{{ js('coffee', 'cjsx') }}
</body>
```
Each one receives multiple tasks names and generate the links to the generated files.
## Extensions
Flask-Gulp comes shiped with four extensions, `coffee`, `cjsx`, `less` and `dest`. The first ones accept an `executable` setting, which holds the corresponding binary location, the default is to call it directly.
To add new extensions use the decorator provided with Flask-Gulp:
```python
from flask_gulp.extensions import extension
@extension
def cjsx(resources):
command = ['cjsx', '-c', '-s']
bare = cjsx.settings.get('bare')
if bare:
command += ['-b']
for filename, data in resources:
process = subprocess.Popen(command,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
out, err = process.communicate(data)
if process.returncode:
yield None, err
else:
dest = replaceExt(filename, '.js')
yield dest, out
```
Each extension receive an iterable object which yields the name and content of each file. The function must return an iterable object with the same format for resulting files. Returning the new file name as `None` will be interpreted as an error.
The variable `<function_name>.settings` holds a dictionary with the keywords provided in the extension initialization, for instance `cjsx(bare=True)`.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Flask-Gulp-0.2.6.tar.gz
(5.5 kB
view hashes)
