Starter project for a chess-based TDD exercise.
To run the application, first ensure that you have installed Poetry on your system. Install
dependencies using the command poetry install.
To run the application, use the command poetry run start. This will pop up a window containing
a chess board. Clicking on one of the white pieces will highlight the square that piece is on,
and also show you the squares it can move to. Except...
None of the rules of chess have been implemented yet! That's your job :)
To run the tests, use the command poetry run pytest tests. This will search the "tests" directory for files starting in test_ or ending in _test. Inside those files, any function starting with test_ will be considered a test.
VSCode debug config has been set up, but you will need to select your virtual environments python interpreter
before running either the tests or app in debug mode. You can do this in VS Code by going to View->Command Palette,
searching for Python: Select Interpreter and then browse your machine to find the appropriate python executable
(e.g. .venv\Scripts\python.exe or .venv\Scripts\python)
The application runs a desktop GUI using Tkinter. If you're running an official Python distribution, this will just work out of the box.
Users relying on third-party Python installations (e.g. Mac/Linux system installs, package managers) may need to configure Tcl/Tk separately, or download an official Python distribution for use on this codebase.
Mac users can check out https://www.python.org/download/mac/tcltk/ for further details.
Sadly, WSL does not support GUIs, so this application will not work from a WSL terminal. Sorry :(
Once you have the app and tests running start on the workshop instructions.