developingΒΆ

  1. Fork and clone the project:

    git clone https://github.com/YOUR-USERNAME/flo.git

  2. Install Vagrant and Virtualbox and launch the development virtual machine:

    vagrant up && vagrant provision

    On vagrant sshing to the virtual machine, note that the PYTHONPATH and PATH environment variables have been altered in this virtual machine so that any changes you make to your local data workflow scripts are automatically reloaded.

  3. On the virtual machine, make sure everything is working by executing workflows in examples/*/flo.yaml

    cd examples/reuters-tfidf
flo run

  4. To be more thorough, there is an automated suite of functional tests to make sure any patches you have made haven’t disturbed the behavior of this package in any substantiative way.

    ./tests/run_functional_tests.sh

    These functional tests are designed to be run on an Ubuntu 12.04 LTS server, just like the virtual machine and the server that runs the travis-ci test suite. There are some other tests that have been added along the way in the Travis configuration. For your convenience, you can run all of these tests with:

    ./tests/run.py

    Current build status: Build Status

  5. Contribute! There are several open issues that provide good places to dig in. Check out the contribution guidelines and send pull requests; your help is greatly appreciated!