Metadata-Version: 2.4
Name: chess-variant
Version: 1.0.3
Summary: A Python API wrapper for Fairyground Variant Challenge.
Home-page: https://fairyground-variant-challenge-da13e5b81e44.herokuapp.com/
Author: Aarush Chugh
Author-email: aachugh@uchicago.edu
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: requests
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Chess Variant Python SDK

The absolute easiest way to create, view, and list chess variants via Python.

Powered by [Fairyground Variant Challenge](https://fairyground-variant-challenge-da13e5b81e44.herokuapp.com/api/docs).

## Installation

```bash
pip install chess-variant
```

## Basic Usage

```python
import chess_variant

# 1. Start a game instantly
game_url = chess_variant.play("3check")
print(f"Play your game here: {game_url}")

# 2. View board state/FEN ('123456' is the roomId)
state = chess_variant.view("123456")
print(f"Current FEN: {state['fen']}")

# 3. List all active game rooms
all_rooms = chess_variant.rooms()
print(f"Currently {len(all_rooms)} active games!")

# 4. Get the move list for a game
move_list = chess_variant.moves("123456")
print(f"Moves played: {move_list}")

# 5. Get the PGN for a game
print(chess_variant.pgn("123456"))

# 6. List all available variants
all_variants = chess_variant.variants()
print(f"Supported variants: {list(all_variants['variants'].keys())[:5]}...")
```
