othellopy 0.1.0

Python package scaffold for Othello/Reversi-related utilities.

othellopy

Python package scaffold for Othello/Reversi-related utilities.

Google Colab

Install the latest main branch in a Colab notebook:

!pip install git+https://github.com/Hietan/othellopy.git@main

Then import the package:

from othellopy.core import Piece
from othellopy.game import OthelloGame
from othellopy.player import BasePlayer

Player example

Use BasePlayer to build your own player class.

from othellopy.core import Piece
from othellopy.player import BasePlayer


class MyPlayer(BasePlayer):
    def __init__(self, color: Piece) -> None:
        super().__init__(color)

    def next_move(self, board: list[list[Piece]]) -> tuple[int, int]:
        return self.get_moves(board)[0]

Board cells use Piece.EMPTY, Piece.BLACK, and Piece.WHITE. Coordinates are zero-based (row, col) pairs, matching board[row][col]. next_move() is called only when the player has at least one valid move.

Game example

Pass two player classes to OthelloGame and call play().

from othellopy.game import OthelloGame

result = OthelloGame(MyPlayer, MyPlayer).play()

print(result.winner)
print(result.black_score, result.white_score)

Use board helpers when debugging in notebooks.

from othellopy.board import print_board

print_board(result.board)

last_turn = result.turns[-1]
print(last_turn.valid_moves)
print_board(last_turn.board)

If a player returns an invalid move, the error message includes the move, valid moves, and the board for that turn.

Git Flow

Use these branch roles:

• main: deployment branch for Colab installs.
• dev: integration branch before release.
• release/*: release preparation branch.
• feat/*: feature work branch.

Recommended flow:

git switch dev
git switch -c feat/my-feature
# work and commit
git switch dev
git merge --no-ff feat/my-feature
git switch -c release/v0.1.0
# final checks
git switch main
git merge --no-ff release/v0.1.0
git push origin main

Development

Create a virtual environment and install the package in editable mode:

uv venv
uv pip install -e ".[dev]"

Run tests:

uv run pytest

Build distributions:

uv build