# OneUp Solver

[![ci](https://github.com/mgaitan/oneup-solver/workflows/ci/badge.svg)](https://github.com/mgaitan/oneup-solver/actions?query=workflow%3Aci)
[![docs](https://img.shields.io/badge/docs-blue.svg?style=flat)](https://mgaitan.github.io/oneup-solver/)
[![pypi version](https://img.shields.io/pypi/v/oneup-solver.svg)](https://pypi.org/project/oneup-solver/)
[![Changelog](https://img.shields.io/github/v/release/mgaitan/oneup-solver?include_prereleases&label=changelog)](https://github.com/mgaitan/oneup-solver/releases)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/mgaitan/oneup-solver/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mgaitan/oneup-solver/blob/main/LICENSE)

OneUp Puzzle Solver 

## Quick Start

Run directly without installing via `uvx`

```bash
uvx oneup-solver --help
```

```{richterm} env PYTHONPATH=../src uv run -m oneup_solver --help
:hide-command: true
```

To install the tool permanently:

```bash
uv tool install oneup-solver
```


```{toctree}
:maxdepth: 2
:caption: Documentation

../CONTRIBUTING.md
../CODE_OF_CONDUCT.md
about_the_docs.md
manual_checks.md
api.md
```