Advent of Code OCR
==================

**Advent of Code OCR** is a Python library that converts Advent of Code ASCII art letters to plain characters.

Put simply, it converts something like this to plain text:

.. code-block:: text

     ██  ███   ██
    █  █ █  █ █  █
    █  █ ███  █
    ████ █  █ █
    █  █ █  █ █  █
    █  █ ███   ██

|Total Downloads| |Supported Versions| |Testing Status| |Coverage| |GitHub last commit| |GitHub Repo stars|

.. |Total Downloads| image:: https://img.shields.io/pepy/dt/advent-of-code-ocr
   :target: https://pypi.org/project/advent-of-code-ocr/
   :alt: Total Downloads

.. |Supported Versions| image:: https://img.shields.io/pypi/pyversions/advent-of-code-ocr.svg
   :target: https://pypi.org/project/advent-of-code-ocr/
   :alt: Supported Versions

.. |Testing Status| image:: https://img.shields.io/github/actions/workflow/status/bsoyka/advent-of-code-ocr/test.yml?branch=main&label=tests
   :target: https://github.com/bsoyka/advent-of-code-ocr/actions/workflows/test.yml
   :alt: Testing Status

.. |Coverage| image:: https://img.shields.io/codecov/c/github/bsoyka/advent-of-code-ocr
   :target: https://codecov.io/github/bsoyka/advent-of-code-ocr
   :alt: Coverage

.. |GitHub last commit| image:: https://img.shields.io/github/last-commit/bsoyka/advent-of-code-ocr
   :target: https://github.com/bsoyka/advent-of-code-ocr
   :alt: GitHub last commit

.. |GitHub Repo stars| image:: https://img.shields.io/github/stars/bsoyka/advent-of-code-ocr
   :target: https://github.com/bsoyka/advent-of-code-ocr
   :alt: GitHub Repo stars

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

advent-of-code-ocr is `available on PyPI <https://pypi.org/project/advent-of-code-ocr/>`_.
Install it with your preferred package manager:

.. code-block:: shell

    $ uv add advent-of-code-ocr
    $ pip install advent-of-code-ocr

advent-of-code-ocr officially supports Python 3.9+.

.. toctree::
    :maxdepth: 2
    :caption: Contents:

    height_6
    cli

Advent of Code is a registered trademark of Eric K Wastl in the United States.
This project is not affiliated with nor endorsed by Advent of Code.