Welcome to the documentation for pgn2json!
=================================================================

.. image:: https://img.shields.io/github/v/tag/unkokaeru/pgn2json?label=version
    :target: https://github.com/unkokaeru/pgn2json
    :alt: GitHub tag (latest by date)
.. image:: https://tokei.rs/b1/github/unkokaeru/pgn2json?category=code
    :target: https://github.com/unkokaeru/pgn2json
    :alt: Lines Of Code
.. image:: https://img.shields.io/github/actions/workflow/status/unkokaeru/pgn2json/continuous_integration.yml?label=tests
    :target: https://github.com/unkokaeru/pgn2json/actions/workflows/continuous_integration.yml
    :alt: Continuous Integration (CI) Tests
.. image:: https://img.shields.io/github/last-commit/unkokaeru/pgn2json
    :target: https://github.com/unkokaeru/pgn2json/actions/workflows/continuous_integration.yml
    :alt: 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 <#features>`__
-  `Installation <#installation>`__
-  `Usage <#usage>`__
-  `Documentation <#documentation>`__
-  `Contributing <#contributing>`__
-  `License <#license>`__

Features
--------

-  ☒ Installable via pip
-  ☒ Command-line interface
-  ☒ Interactive documentation
-  ☐ Some new planned feature

Installation
------------

To install pgn2json, simply run:

.. code-block:: bash

    pip install pgn2json

Usage
-----

After installation, you can use pgn2json by
running:

.. code:: 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.

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`