Welcome to the documentation for pgn2json!

GitHub tag (latest by date) Lines Of Code Continuous Integration (CI) Tests GitHub last commit

Converts a PGN file to a JSON file. Designed for displaying Chess.com games inside of Obsidian using the Chess Study plugin.

Features

  • ☒ Installable via pip

  • ☒ Command-line interface

  • ☒ Interactive documentation

  • ☐ Some new planned feature

Installation

To install pgn2json, simply run:

pip install pgn2json

Usage

After installation, you can use pgn2json by running:

$ python3 -m pgn2json
# or
$ pgn2json

Documentation

For more information, you can find the documentation within the docs directory or on the project’s [GitHub Pages](https://unkokaeru.github.io/pgn2json/).

Contributing

Contributions are welcome! Please refer to our CONTRIBUTING.md for more information.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Indices and tables