Metadata-Version: 2.1
Name: pgn2json
Version: 0.1.2
Summary: Converts a PGN file to a JSON file. Designed for displaying Chess.com games inside of Obsidian using the Chess Study plugin.
Home-page: https://github.com/unkokaeru/pgn2json
License: MIT
Author: William Fayers
Author-email: william@fayers.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: chess (>=1.11.0,<2.0.0)
Requires-Dist: rich (>=13.7.1,<14.0.0)
Requires-Dist: shortuuid (>=1.0.13,<2.0.0)
Project-URL: Repository, https://github.com/unkokaeru/pgn2json
Description-Content-Type: text/markdown

# pgn2json

[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/unkokaeru/pgn2json?label=version)](https://github.com/unkokaeru/pgn2json)
[![Lines Of Code](https://tokei.rs/b1/github/unkokaeru/pgn2json?category=code)](https://github.com/unkokaeru/pgn2json)
[![Continuous Integration (CI) Tests](https://img.shields.io/github/actions/workflow/status/unkokaeru/pgn2json/continuous_integration.yml?label=tests)](https://github.com/unkokaeru/pgn2json)
[![GitHub last commit](https://img.shields.io/github/last-commit/unkokaeru/pgn2json)](https://github.com/unkokaeru/pgn2json)

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

- [pgn2json](#pgn2json)
    - [Features](#features)
    - [Installation](#installation)
    - [Usage](#usage)
    - [Documentation](#documentation)
    - [Contributing](#contributing)
    - [License](#license)

## Features

- [x] Installable via pip
- [x] Command-line interface
- [x] Interactive documentation

## Installation

To install pgn2json, simply run:

```bash
pip install pgn2json
```

## Usage

After installation, you can use pgn2json by running:

```bash
$ python3 -m pgn2json
# or
$ pgn2json
```

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

## Contributing

Contributions are welcome! Please refer to our [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
