Metadata-Version: 2.4
Name: pca-trame
Version: 0.0.3
Author: Etienne Madinier
Maintainer: Etienne Madinier
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: pydantic==2.12.5
Requires-Dist: markdown==3.10
Requires-Dist: bs4==0.0.2
Provides-Extra: dev
Requires-Dist: djlint==1.36.4; extra == "dev"
Requires-Dist: black==24.4.2; extra == "dev"
Requires-Dist: ruff==0.11.2; extra == "dev"
Requires-Dist: jinja2==3.1.6; extra == "dev"
Dynamic: license-file

# Trame

## Concepts

- A **Trame** is a list of **Pieces**, which are themselves made of **Actors**
- The goal is to display information, *Piece by Piece*




## Dev / Install


### Install locally with dev dependencies

```bash
pip3 install -e ".[dev]"
```

**If you don't need dev dependencies, you can install locally without the `.[dev]` suffix :**

```bash
pip3 install -e .
```


### Try it out !

```bash
python -m tests.sandbox README.md
python -m tests.sandbox README.md --style tests/data/obvious-style.css
```

### Install locally

```bash
pip install -e .
```

### Run unit tests

```bash
python -m tests
```

### Sandbox

```bash
python -m tests.sandbox /path/to/markdown.md
python -m tests.sandbox /path/to/markdown.md --port=8000 --style=/path/to/style.css
```


