pgn-read 2.1

Portable Game Notation (PGN) parser

Contents

• Description

• Installation Instructions

• Tests

• Notes

Description

This package provides a parser for chess game scores in PGN format.

Both the strict export format and many less strict import formats are supported.

Chess variants are not supported.

The game module provides the Game, GameStrictPGN, GameTextPGN, and GameIgnoreCasePGN, classes and the generate_fen_for_position function.

The parser module provides the PGN class and add_token_to_game function.

The PGN.read_games method yields instances of the Game class, or a subclass, generated from a file-like source or string.

The add_token_to_game function searches for the next PGN token in a string and applies it to an instance of the Game class, or a subclass.

The generate_fen_for_position function returns the Forsyth English Notation (FEN) string for the representation of a position in the Game class, or a subclass.

Installation Instructions

Install the package by typing

python setup.py install

at the command prompt with setup.py in the current directory.

You may need to give the path and version of Python depending on your system’s configuration:

<path to python>/python<version> setup.py install

For example

C:\Python33\python setup.py install

on Microsoft Windows or

python3.3 setup.py install

on Unix-like systems.

Use Python 3.3 or later.

Tests

Tests are available at the repository in the pgn_read.core.tests sub-package.

Copy the tests directory and run tests by typing, for example,

python -m pgn_read.core.tests.test_squares

at the command prompt with setup.py in the current directory.

Notes

Project name and package name changed from ‘pgn’ to ‘pgn-read’ prior to upload to PyPI.

The version numbers of pgn-read continue on from pgn.

The pgn_read.core.tests sub-package was removed from the distribution created by setup when the repository was created.