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. It is added as a requirement to the requirements.txt file.

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.