Getting Started

Installing from Github

  1. Fork the main repository from

  2. Storyscript is a Python project. The suggested installation is inside a virtual environment:

    virtualenv --python=python3.6 storyscript
  3. Change directory and activate the virtual environment:

    cd storyscript
    source bin/activate
  4. Clone your fork:

    git clone
  5. Cd in storyscript, and install it:

    python install
  6. Check the installation:

    storyscript --version
  7. You have succesfully installed Storyscript! You might need to install development dependencies as well:

    pip install tox pytest pytest-mock
  8. Check you can run the tests:


You are now ready to start contributing to Storyscript!