the-spymaster-api

Python client implementation for The Spymaster HTTP backend.


Keywords
api, codenames, django, python
Install
pip install the-spymaster-api==1.8.0

Documentation

The Spymaster Backend

PyPI version Pipeline Ruff Code style: black Imports: isort Type checked: mypy Linting: pylint

A generic backend service for Codenames board game.
Provides game state and opponent solvers for the the-spymaster-bot.

Local development

Environment Setup

  1. Install Python 3.11.
  2. Create a virtual environment and set source.
  3. Run make setup-local-env.

Workflow

  1. Lint using make lint.
  2. Run tests using make test / make cover.

Deployment