<img src=/docs/waterbutler.png?raw=true" width="25%" style="float:left;">

master Build Status:

develop Build Status:

Docs can be found here

In order to run waterbutler, you must have a virtualenv created for waterbutler running python 3.5.

For MacOSX, you can install the latest version of python3 using:

brew install python3

For Ubuntu users:

apt-get install python3.5

After completing the installation of Python 3.5, you must create the virtual environment, this can be done with the following commands:

pip install virtualenv
pip install virtualenvwrapper
mkvirtualenv --python=python3.5 waterbutler
pip install invoke==0.11.1
invoke install
invoke server

The above code will get the virtualenv up and running for the first time. After the initial setup, you can run waterbutler by running:

workon waterbutler
invoke server

vim ~/.cos/waterbutler-test.json

Python 3.5's asyncio currently has a bug that is triggered by turning on debugging. If you are upgrading from the 3.4-based WaterButler, make sure to set SERVER_CONFIG.DEBUG to false in your waterbutler-test.json, e.g.

{
  "OSFSTORAGE_PROVIDER_CONFIG": {
    "HMAC_SECRET": "changeme"
  },
  "SERVER_CONFIG": {
    "ADDRESS": "localhost",
    "PORT": 7777,
    "DOMAIN": "http://localhost:7777",
    "DEBUG": false,
    "HMAC_SECRET": "changeme"
  },
  "OSF_AUTH_CONFIG": {
      "API_URL": "http://localhost:5000/api/v1/files/auth/"
  }
}

To run all the tests you will need install some requirements, so try running:

workon waterbutler
invoke install --develop
invoke test

Want to help save science? Want to get paid to develop free, open source software? Check out our openings!