Giter Club home page Giter Club logo

chessington-python's Introduction

Chessington

Starter project for a chess-based TDD exercise.

Running the application

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 :)

Running the tests

To run the tests, use the command poetry run pytest tests. This will run any test defined in a function matching the pattern test_* or *_test, in any file matching the same patterns, in the tests directory.

Debugging

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)

GUI Dependencies

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.

Notes for WSL users

Sadly, WSL does not support GUIs, so this application will not work from a WSL terminal. Sorry :(

chessington-python's People

Contributors

scl-softwire avatar jonesey13 avatar joshadampowell avatar robo-softwire avatar hugh-emerson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.