Metadata-Version: 2.4
Name: pyLynx
Version: 3.0.1
Summary: Lynx: Local Yard for Notes and eXercises
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer<1.0,>=0.12
Requires-Dist: rich>=13.0
Requires-Dist: pygments>=2.16
Requires-Dist: pillow>=10.0
Requires-Dist: pathspec>=0.12
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Dynamic: license-file

# lynx
lynx: Local Yard for Notes and eXercises. (A lecture management system)

It provides a simple CLI interface to manage your lecture notes and exercises. You can easily create, organize, and pack your lecture materials/homework with lynx.

## Installation

### With uv (recommended)

```bash
uv tool install pyLynx
```

### From source

```bash
git clone https://github.com/a1fredbao/lynx
uv tool install .
```

### Development setup (uv virtual environment)

```bash
uv sync --extra dev
pytest
```

`uv sync`/`uv sync --extra dev` will create and manage the project virtual environment automatically.

## CLI usage

```bash
lynx course <course_name>
lynx lecture <lecture_name>
lynx clean
lynx pack
```
