Skip to main content

Python3 library for efficient chess draw-gen functions

Project description

PyPi Release Docker CI

ChessLib Python Extension

About

This project provides an efficient chess draw generation extension for Python3. The main purpose of this project is enabling further TensorFlow AI projects and learning how to write an efficient Python3 extension (using good old C).

Usage

Install the official Python package using pip:

pip install chesslib

Use the chesslib package like in the following example:

import chesslib
import numpy as np
import random


def test():

    # create a new chess board in start formation
    board = chesslib.ChessBoard_StartFormation()

    # generate all possible draws
    draws = chesslib.GenerateDraws(board, chesslib.ChessColor_White, chesslib.ChessDraw_Null, True)

    # apply one of the possible draws
    draw_to_apply = draws[random.randint(0, len(draws) - 1)]
    new_board = chesslib.ApplyDraw(board, draw_to_apply)

    # write the draw's name
    print(chesslib.VisualizeDraw(draw_to_apply))

    # visualize the board before / after applying the draw
    print(chesslib.VisualizeBoard(board))
    print(chesslib.VisualizeBoard(new_board))

    # revert the draw (just call ApplyDraw again with the new board)
    rev_board = chesslib.ApplyDraw(new_board, draw_to_apply)

    # get the board's 40-byte-hash and create a new board instance from the hash
    board_hash = chesslib.Board_ToHash(board)
    board_reloaded = chesslib.Board_FromHash(board_hash)

    # see tests/ folder for more examples

How to Develop

The commands for dev-testing the chesslib are wrapped within a Docker environment. Therefore build the 'Dockerfile-dev' file which takes your source code and performs all required CI steps (build + install + unit tests). Afterwards you may attach to the Docker image with the bash console interactively and run commands, etc.

# make a dev build using the 'Dockerfile-dev' build environment
# this runs all CI steps (build + install + unit tests)
docker build . --file Dockerfile-dev -t "chesslib-dev"

# attach to the build environment's interactive bash console (leave the session with 'exit')
docker run "chesslib-dev" -it bash

# mount a Python test script into the build environment and run it
docker run -v $PWD:/scripts "chesslib-dev" python3 /scripts/test.py

Advantages of this approach are that it simplifies the dev machine setup a lot as you only need Docker, git and a good text editor on your local machine. Moreover you don't mess up your dev machine when trying to build and install the chesslib package for debugging again and again. And most importantly you keep your local copy of the git repo clean as all temporary files are created within the Docker container, so you basically don't need to worry about accidentially including build files into git commits, etc.

For a quickstart, set up your dev machine as a VM (e.g. Ubuntu 20.04 hosted by VirtualBox). After successfully creating the VM, use following commands to install all essential dev tools (git, docker, good text editor).

# install docker (e.g. Ubuntu 20.04)
sudo apt-get update && sudo apt-get install -y git docker.io
sudo usermod -aG docker $USER && reboot

# download the project's source code (if you haven't done before)
git clone https://github.com/Bonifatius94/ChessLib.Py
cd ChessLib.Py

# install the 'Visual Studio Code' text editor (optional)
sudo snap install code --classic

Copyright

You may use this project under the MIT licence's conditions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

chesslib-1.0.333890387-cp38-cp38-manylinux2010_x86_64.whl (63.9 kB view details)

Uploaded CPython 3.8 manylinux: glibc 2.12+ x86-64

chesslib-1.0.333890387-cp37-cp37m-manylinux2010_x86_64.whl (64.6 kB view details)

Uploaded CPython 3.7m manylinux: glibc 2.12+ x86-64

chesslib-1.0.333890387-cp36-cp36m-manylinux2010_x86_64.whl (63.7 kB view details)

Uploaded CPython 3.6m manylinux: glibc 2.12+ x86-64

chesslib-1.0.333890387-cp36-cp36m-manylinux1_x86_64.whl (54.3 kB view details)

Uploaded CPython 3.6m

File details

Details for the file chesslib-1.0.333890387-cp38-cp38-manylinux2010_x86_64.whl.

File metadata

  • Download URL: chesslib-1.0.333890387-cp38-cp38-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 63.9 kB
  • Tags: CPython 3.8, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

File hashes

Hashes for chesslib-1.0.333890387-cp38-cp38-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 5126285bd7de40fce1a1277bbb842ecd077f4b23dc85239c8527febed39d2a62
MD5 a6921aff498fcd38ccdb9b3e0154a3c8
BLAKE2b-256 e7bbcf4ef8619b26151817f587674e6e8c09cfe289a30637f92673996ea4af7c

See more details on using hashes here.

File details

Details for the file chesslib-1.0.333890387-cp38-cp38-manylinux1_x86_64.whl.

File metadata

  • Download URL: chesslib-1.0.333890387-cp38-cp38-manylinux1_x86_64.whl
  • Upload date:
  • Size: 54.7 kB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

File hashes

Hashes for chesslib-1.0.333890387-cp38-cp38-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 fbbb6e3aa64d131aba7a7f044e27ffb3666cf755e799c4b488679d1da90062e8
MD5 2b8d438d274d9a37f759752c6c20d908
BLAKE2b-256 ea05aec0dbac3c8223a7515857cd22704e8e2c1651419ca9a421928ed54c07eb

See more details on using hashes here.

File details

Details for the file chesslib-1.0.333890387-cp37-cp37m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: chesslib-1.0.333890387-cp37-cp37m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 64.6 kB
  • Tags: CPython 3.7m, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

File hashes

Hashes for chesslib-1.0.333890387-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 b1934fbd28f985618cb8629b03f9171bf7e7a6420277b7902fd36d8036a61496
MD5 c9a9f672e01c954d84566992fc0ccae9
BLAKE2b-256 fa79376888eb38c600b83552e6a3a395515a53f3ad7603013f0d746c7088d1b1

See more details on using hashes here.

File details

Details for the file chesslib-1.0.333890387-cp36-cp36m-manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for chesslib-1.0.333890387-cp36-cp36m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4e6c5af3d9945b67b8e19d0bef1192ee35b13f1e9855a12d1d42b3713f1189b8
MD5 ee4b0f47cb25a077ed173287cb9aba5c
BLAKE2b-256 e9c76f2de5a4c60e80d8b0b8fa8b285ec2a18a6e8e58f496a7ebac134abc21e3

See more details on using hashes here.

File details

Details for the file chesslib-1.0.333890387-cp36-cp36m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: chesslib-1.0.333890387-cp36-cp36m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 63.7 kB
  • Tags: CPython 3.6m, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

File hashes

Hashes for chesslib-1.0.333890387-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 34201297441d9c5098797789048207936e51365b6a7e302b6178d200c681e660
MD5 168564a611760b4bf569783a19981fe0
BLAKE2b-256 2f9a44b0f37c765ebc6a73418673d9027abc28e43b3dd64be2e9d5bfa3ede1a1

See more details on using hashes here.

File details

Details for the file chesslib-1.0.333890387-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: chesslib-1.0.333890387-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 54.3 kB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

File hashes

Hashes for chesslib-1.0.333890387-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 41a33e798c50289ac93d19c17557d5b70cf7b1739cad3186584ee49391b220af
MD5 e71bbf16b8dab9a2f8ca53f9d9919ece
BLAKE2b-256 616973404698809a2d894e5c44489a31977b57df8f66b94315b0df1a9199bf84

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