Skip to main content

A draughts library for Python with move generation, PDN reading and writing, engine communication and balloted openings

Project description

pydraughts

PyPI version Tests Build CodeQL

pydraughts is a draughts library for Python with move generation, PDN reading and writing, engine communication and balloted openings. It is based on ImparaAI/checkers.

Installing

Download and install the latest release:

pip install pydraughts

Features

Note: White always starts. Black always has the squares starting from 1 (e.g. 1-20 in international draughts).

Variants:

  • Standard (International)
  • Frisian
  • frysk!
  • Antidraughts
  • Breakthrough
  • Russian
  • Brazilian
  • English/American
  • Italian
  • Turkish

Engine protocols:

  • Hub
  • DXP
  • CheckerBoard

PDN Reading and Writing

  • Import pydraughts
from draughts import Game, Move, WHITE, BLACK
  • Create a game
game = Game(variant="standard", fen="startpos")
  • Make a move
game.move([34, 30])
  • Get legal moves
moves, captures = game.legal_moves()
  • Detect wins and draws
has_white_won = game.has_player_won(WHITE)
is_draw = game.is_draw()
winnner = game.get_winner()
is_game_over = game.game_over()
  • Convert move to other types
move = Move(game, board_move=moves[0]).pdn_move
  • Get fen
fen = game.get_li_fen()
  • Communicate with engines
from draughts.engine import HubEngine, Limit
engine = HubEngine("scan.exe hub")
engine.init()
limit = Limit(time=10)
engine_move = engine.play(game, limit, ponder=False)
  • Read PDN games
from draughts.PDN import PDNReader
games = PDNReader(filename=filepath)
game = games.games[0]
moves = game.moves
  • Write PDN games
from draughts.PDN import PDNWriter
games = PDNWriter(filename=filepath, board=game)
  • Get a ballot
from draughts.ballots import Ballots
ballots = Ballots('english')
ballot1 = ballots.get_ballot()
ballot2 = ballots.get_ballot()

Acknowledgements

Thanks to fishnet which was modified to add support for Hub engines. Thanks to akalverboer for their DXC100_draughts_client which was modified to add support for DXP engines.

License

pydraughts is licensed under The MIT License. Check out LICENSE for the full text. The licenses of the other projects that pydraughts uses are in the other_licenses folder.

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

pydraughts-0.4.7.tar.gz (175.6 kB view details)

Uploaded Source

Built Distribution

pydraughts-0.4.7-py3-none-any.whl (185.7 kB view details)

Uploaded Python 3

File details

Details for the file pydraughts-0.4.7.tar.gz.

File metadata

  • Download URL: pydraughts-0.4.7.tar.gz
  • Upload date:
  • Size: 175.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.6.1 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.2

File hashes

Hashes for pydraughts-0.4.7.tar.gz
Algorithm Hash digest
SHA256 54b64305778358c50f02344b15b8aee6b304898ec1b653bf86ab4ddfb5268274
MD5 e68b61f9bd7192282abbbb78de67e023
BLAKE2b-256 1b96666330d99556c410d74994235fd58b9bd6c45c6b6416a085cd4deb26f180

See more details on using hashes here.

File details

Details for the file pydraughts-0.4.7-py3-none-any.whl.

File metadata

  • Download URL: pydraughts-0.4.7-py3-none-any.whl
  • Upload date:
  • Size: 185.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.6.1 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.2

File hashes

Hashes for pydraughts-0.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9ab49285361093dbf773387c51b5919a4a7d13b6b9ad0edb3333b324db857528
MD5 e00bdafb82f77afa5db4b8f33b11dab1
BLAKE2b-256 abb9880abdbe4029de54b8ccf1fedfaffa386353646441a23da9da343cf609a1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page