Why?¶

• Because I like Drake but can’t stand the startup time of java.
• Because I can (actually to see if I can, but it turns out I can).

Features¶

• simple but robust functionality
• easy to use and extend (the code, minus the tests, is around 300 lines of python)
• fast startup time (compared to Drake)
• Documentation: https://faz.readthedocs.org.

Installation¶

Using pypi

pip install faz

Usage¶

From the command line, just type

faz

without arguments, the program will read the tasks from a file called “fazfile”. If you want to use another filename, just give that as an argument to the program

faz <filename>

to get a list of command line arguments type

faz -h

Task file basics¶

The task file is a plain text file, with a syntax similar to Drake input files. The following is an example with two tasks

# file1 <-
touch file1

# file2 <- file1
cat file1 > file2

Lines starting with “#” and having the symbols “<-” signal a task. On the left of the “<-” is a (comma separated) list of the files produced by the task. On the right are the task dependencies, the files needed to run that task. In the above example the first task has no dependencies, and produces a file called “file1”. The second task has “file1” as a dependency, and has as output a file called “file2”.

The outputs and inputs and inputs of each task are used by the program to estabilish the order by which the tasks have to be run, and if they need to be run. In the example above, if a file called “file1” was already present in the directory the program was run, the first task would not be executed.

The code sections are all the lines in betweeen the two task lines. In these two tasks, they are just are just plain bash commands but could be, for example, python code

# file1 <-
touch file1

# file2 <- file1 :python
f1 = open("file1")
text = file1.read()
f2 = open("file2", "w")
f2.write(text)

note that, in the second task, there’s an extra option ”:python”, wich indicates to the program that the code from this task is python code. Options are a list of (comma separated) keywords following the ”:”, and must be placed after the inputs.

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up faz for local development.

1. Fork the faz repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/faz.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv faz
   $ cd faz/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 faz tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check https://travis-ci.org/hmartiniano/faz/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_faz

Development Lead¶

• Hugo Martiniano <hugomartiniano@gmail.com>

Contributors¶

None yet. Why not be the first?