Developer notes

Notes for developers/maintainers of pugdebug.

Sending pull requests

Before sending a pull request, please run flake8 on the project.

Updating the Unreleased part of the change log file would be nice.

Syncing gh-pages

git checkout gh-pages
git checkout master README.md
mv README.md index.md

And add

---
layout: index
---

To the beginning of index.md.

Finally:

git add index.md
git commit -m 'Sync master and gh-pages'
git push origin gh-pages

Installing PyInstaller

PyInstaller is used to build pugdebug binaries. As pugdebug is written in Python 3.4, the Python3 version of PyInstaller is used.

Download the archive for the Python3 branch, and install it according to PyInstaller's documentation for installing from the archive.

Using PyInstaller

pugdebug includes a build.sh file for building binaries with PyInstaller on Linux systems, and a build.bat file for building binaries on Windows systems.