Metadata-Version: 2.4
Name: chess-mnemonic-protocol
Version: 0.1.3
Summary: Chess Mnemonic Protocol tools
Project-URL: Example Website, https://github.com/julesora/cmp-website.git
Project-URL: Repository, https://github.com/julesora/cmp
Project-URL: Specification, https://github.com/julesora/cmp/blob/main/spec/cmp-0001.md
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown

Chess Mnemonic Protocol
=======================

Chess Mnemonic Protocol (CMP) is a small text format for legal chess move
sequences.

Example Website
---------------

See the [example website repository](https://github.com/julesora/cmp-website.git).

Install
-------

    python -m pip install chess-mnemonic-protocol

Quick Start
-----------

Check a mnemonic:

    cmp check cmp1 e2e4 e7e5

Convert to SAN:

    cmp convert --to san cmp1 e2e4 e7e5 g1f3

Convert to PGN:

    cmp convert --to pgn cmp1 e2e4 e7e5 g1f3

Python
------

    import cmp

    value = 'cmp1 e2e4 e7e5 g1f3'

    cmp.check(value)
    cmp.normalize(value)
    cmp.convert_mnemonic(value, 'san')

Format
------

CMP 1 starts with `cmp1` followed by legal moves in UCI notation.

    cmp1 e2e4 e7e5 g1f3

Documentation
-------------

* Format rules: spec/cmp-0001.md
* Test vectors: vectors.json
* Contributing: CONTRIBUTING.md
* Security: SECURITY.md
