- Easy to learn.
- Build tasks are just python funtions.
- Manages dependencies between tasks.
- Automatically generates a command line interface.
- Rake style param passing to tasks
- Supports python 2.7 and python 3.x
You can install pynt from the Python Package Index (PyPI) or from source.
Using pip
$ pip install pynt
Using easy_install
$ easy_install pynt
The build script is written in pure Python and pynt takes care of managing any dependencies between tasks and generating a command line interface.
Writing build tasks is really simple, all you need to know is the @task
decorator. Tasks are just regular Python functions marked with the
@task() decorator. Dependencies are specified with @task() too.
Tasks can be ignored with the @task(ignore=True). Disabling a task
is an useful feature to have in situations where you have one task that
a lot of other tasks depend on and you want to quickly remove it from
the dependency chains of all the dependent tasks. Note that any task
whose name starts with an underscore(_) will be considered
private. Private tasks are not listed in with pynt -l, but they can
still be run with pynt _private_task_name
#!/usr/bin/python
import sys
from pynt import task
@task()
def clean():
'''Clean build directory.'''
print 'Cleaning build directory...'
@task(clean)
def html(target='.'):
'''Generate HTML.'''
print 'Generating HTML in directory "%s"' % target
@task()
def _copy_resources():
'''Copy resource files. This is a private task. "pynt -l" will not list this'''
print('Copying resource files')
@task(clean, _copy_resources)
def html(target='.'):
'''Generate HTML.'''
print 'Generating HTML in directory "%s"' % target
@task(clean, _copy_resources, ignore=True)
def images():
'''Prepare images.'''
print 'Preparing images...'
@task(start_server) #Depends on task with all optional params
def stop_server():
print 'Stopping server....'
@task()
def copy_file(src, dest):
print 'Copying from %s to %s' % (src, dest)
@task()
def echo(*args,**kwargs):
print args
print kwargs
# Default task (if specified) is run when no task is specified in the command line
# make sure you define the variable __DEFAULT__ after the task is defined
# A good convention is to define it at the end of the module
# __DEFAULT__ is an optional member
__DEFAULT__=start_server
The command line interface and help is automatically generated. Task descriptions are extracted from function docstrings.
$ pynt -h
usage: pynt [-h] [-l] [-v] [-f file] [task [task ...]]
positional arguments:
task perform specified task and all its dependencies
optional arguments:
-h, --help show this help message and exit
-l, --list-tasks List the tasks
-v, --version Display the version information
-f file, --file file Build file to read the tasks from. Default is
'build.py'
$ pynt -l Tasks in build file ./build.py: clean Clean build directory. copy_file echo html Generate HTML. images [Ignored] Prepare images. start_server [Default] Start the server stop_server Powered by pynt - A Lightweight Python Build Tool.
pynt takes care of dependencies between tasks. In the following case start_server depends on clean, html and image generation (image task is ignored).
$ pynt #Runs the default task start_server. It does exactly what "pynt start_server" would do. [ example.py - Starting task "clean" ] Cleaning build directory... [ example.py - Completed task "clean" ] [ example.py - Starting task "html" ] Generating HTML in directory "." [ example.py - Completed task "html" ] [ example.py - Ignoring task "images" ] [ example.py - Starting task "start_server" ] Starting server at localhost:80 [ example.py - Completed task "start_server" ]
The first few characters of the task name is enough to execute the task, as long as the partial name is unambigious. You can specify multiple tasks to run in the commandline. Again the dependencies are taken taken care of.
$ pynt cle ht cl [ example.py - Starting task "clean" ] Cleaning build directory... [ example.py - Completed task "clean" ] [ example.py - Starting task "html" ] Generating HTML in directory "." [ example.py - Completed task "html" ] [ example.py - Starting task "clean" ] Cleaning build directory... [ example.py - Completed task "clean" ]
The 'html' task dependency 'clean' is run only once. But clean can be explicitly run again later.
pynt tasks can accept parameters from commandline.
$ pynt "copy_file[/path/to/foo, path_to_bar]" [ example.py - Starting task "clean" ] Cleaning build directory... [ example.py - Completed task "clean" ] [ example.py - Starting task "copy_file" ] Copying from /path/to/foo to path_to_bar [ example.py - Completed task "copy_file" ]
pynt can also accept keyword arguments.
$ pynt start[port=8888]
[ example.py - Starting task "clean" ]
Cleaning build directory...
[ example.py - Completed task "clean" ]
[ example.py - Starting task "html" ]
Generating HTML in directory "."
[ example.py - Completed task "html" ]
[ example.py - Ignoring task "images" ]
[ example.py - Starting task "start_server" ]
Starting server at localhost:8888
[ example.py - Completed task "start_server" ]
$ pynt echo[hello,world,foo=bar,blah=123]
[ example.py - Starting task "echo" ]
('hello', 'world')
{'blah': '123', 'foo': 'bar'}
[ example.py - Completed task "echo" ]
You can break up your build files into modules and simple import them into your main build file.
from deploy_tasks import * from test_tasks import functional_tests, report_coverage
- Calum J. Eadie - pynt is preceded by and forked from microbuild, which was created by Calum J. Eadie.
If you want to make changes the repo is at https://github.com/rags/pynt. You will need pytest to run the tests
$ ./b t
It will be great if you can raise a pull request once you are done.
If you find any bugs or need new features please raise a ticket in the `issues section <https://github.com/rags/pynt/issues>`_ of the github repo.
pynt is licensed under a MIT license
Status| image:: https://travis-ci.org/rags/pynt.png?branch=master
