For Contributors ================ Setup ----- Requirements ~~~~~~~~~~~~ - Make: - Windows: http://mingw.org/download/installer - Mac: http://developer.apple.com/xcode - Linux: http://www.gnu.org/software/make - pipenv: http://docs.pipenv.org - Graphviz: http://www.graphviz.org/Download.php To confirm these system dependencies are configured correctly: .. code:: sh $ make doctor Installation ~~~~~~~~~~~~ Install project dependencies into a virtual environment: .. code:: sh $ make install Development Tasks ----------------- Testing ~~~~~~~ Manually run the tests: .. code:: sh $ make test or keep them running on change: .. code:: sh $ make watch .. In order to have OS X notifications, ``brew install terminal-notifier``. Documentation ~~~~~~~~~~~~~ Build the documentation: .. code:: sh $ make docs Static Analysis ~~~~~~~~~~~~~~~ Run linters and static analyzers: .. code:: sh $ make pylint $ make pycodestyle $ make pydocstyle $ make check # includes all checks Continuous Integration ---------------------- The CI server will report overall build status: .. code:: sh $ make ci Release Tasks ------------- Release to PyPI: .. code:: sh $ make upload