A python chessboard library for representing game positions.
Project description
chess-board
What is chess-board?
chess-board is a Python chessboard package with a flexible "just a board" API for graphically representing game positions.
What chess-board is not
- A chess engine
- A legal move validator
- A PGN parser
While chess-board is designed to work well with any of these, the idea behind chess-board is that the logic that controls the board should be independent of those other problems.
Entry Points
from chessboard import display
valid_fen = 'rnbqkbnr/pp1ppppp/8/2p5/4P3/5N2/PPPP1PPP/RNBQKB1R b KQkq - 1 2'
# Initialization
game_board = display.start()
# Position change/update
display.update(valid_fen, game_board)
# Checking GUI window for QUIT event. (Esc or GUI CANCEL)
display.check_for_quit()
# Close window
display.terminate()
Usage
test.py - example
from chessboard import display
valid_fen = 'rnbqkbnr/pp1ppppp/8/2p5/4P3/5N2/PPPP1PPP/RNBQKB1R b KQkq - 1 2'
game_board = display.start()
while True:
display.check_for_quit()
display.update(valid_fen, game_board)
display.terminate()
Installation
Download and install the latest release:
# install into virtualenv
source env/bin/activate
pip install chess-board
or
# install with pipenv
pipenv install chess-board
or
# install system-wide
pip install chess-board
Alternatively, you could git clone this repo and add the directory to your package.
git clone https://github.com/ahira-justice/chess-board.git
Dependencies
pygame==2.1.2
chess-board installation automatically installs latest pygame version.
License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
chess-board-0.3.1.tar.gz
(37.1 kB
view hashes)
Built Distribution
Close
Hashes for chess_board-0.3.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf8f944d9a4dd887d39df9b3e640ed788a9ce268b2ee182df84cb9e81dc40f7f |
|
MD5 | 1d2df03bf4667b01094fffba0a104aa8 |
|
BLAKE2b-256 | 555fdfbaa87c10880d7debac8a7582a2f59933f7143c907a12670ebc71769aa4 |