Metadata-Version: 2.1
Name: beaver_cli
Version: 0.1.5
Summary: CLI application for Beaver project
Author: nikita zigman
Author-email: zigman.nikita@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: pydantic (>=2.8.0,<3.0.0)
Requires-Dist: pydantic-settings (>=2.3.4,<3.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: syntax (>=0.1.3.2,<0.2.0.0)
Requires-Dist: textual-dev (>=1.5.1,<2.0.0)
Requires-Dist: textual[syntax] (>=0.70.0,<0.71.0)
Requires-Dist: typer (>=0.12.3,<0.13.0)
Description-Content-Type: text/markdown

# Beaver

Beaver is a command-line application that combines typing practice with algorithm learning. Inspired by Monkeytype and LeetCode, it provides a fun and educational way to improve your coding skills and typing speed by having you type out classical algorithms in a Text User Interface (TUI) environment.


## Features

- **Typing Practice with Algorithms**: Improve your typing speed and accuracy by typing out actual algorithm code.
- **Algorithm Refresh**: Revisit and reinforce your understanding of classical algorithms and data structures.
- **TUI Frontend**: Enjoy an intuitive and distraction-free typing experience in your terminal.

## Installation

Beaver is available on [PyPI](https://pypi.org/project/beaver/). You can install it using `pip`:

```bash
pip install beaver_cli
```

## Usage
After installing, you can start using Beaver directly from your terminal.

### Starting a Session
To begin a typing session, simply run:
```bash
beaver_cli
```

### Screenshots
![screenshot](docs/screenshot.png)


### License
This project is licensed under the GNU GENERAL PUBLIC LICENSE.

