Development
Notes on how to develop guizero (on Windows).
Setup
Upgrade pip:
python -m pip install pip --upgrade
Install / upgrade pre-requisites:
pip install mkdocs mkdocs-bootswatch wheel twine virtualenv pytest pillow setuptools --upgrade
Python library
Uninstall previous versions of guizero:
pip uninstall guizero
Create a virtual environment (not essential, but a good idea!):
virtualenv guizero-[versionno]
cd guizero-[versionno]
Activate your virtual environment:
Scripts\activate
Checkout and install guizero for development:
git clone https://github.com/lawsie/guizero
cd guizero
git checkout dev
pip install -e .
When you have finished your development, deactivate your virtual environment:
Scripts\deactivate
Tests
If running the tests inside a virtual environment you will need to install pytest in that virtual environment.
pip install pytest
To run all the automated tests:
cd guizero\tests
pytest -v
To run a specific test:
cd guizero\tests
pytest -v [test_filename.py]
Note - tkinter can error when running the tests usually when the interpreter doesn't start properly, it doesn't seem to like being initialised and destroyed hundreds of times, I suspect a file locking issue as you don't see the problem on Linux. So sometimes you might get a test fail with an error like This probably means that tk wasn't installed properly.. Just re-run the last failed errors! pytest --lf -v
Documents
Test documents by serving up MkDocs:
cd guizero\docs-src
mkdocs serve