Contribution Guide

Walter’s code is currently hosted on GitLab at abre/walter. If you’re not familiar with GitLab, it’s very similar to GitHub; you can sign in with your GitHub account, and then fork, modify and file merge requests.

Setting Up

  • To install Walter for development, run pip install -e .[dev,docs].
  • Tests are written using pytest; just run the command pytest to run them.
  • Documentation is built with Sphinx. You can just run cd docs; make html and browse the generated HTML files, but if you install devd and modd, then run the command modd, you’ll get a nice live-reloading view served on localhost port 8000 (or run e.g. env PORT=1337 modd to serve on a different port).