01 Installation und Setup

Installation und Setup

Voraussetzungen

• Python 3.11 oder hoeher
• Poetry (Dependency Management)
• Git

Falls Poetry noch nicht installiert ist:

curl -sSL https://install.python-poetry.org | python3 -

Falls eine bestimmte Python-Version noetig ist:

# Via pyenv
pyenv install 3.12
pyenv local 3.12

# Oder via Conda
conda create -n manuscript python=3.12
conda activate manuscript

Projekt klonen und installieren

git clone https://github.com/dein-user/manuscript-tools.git
cd manuscript-tools
make install

Das installiert alle Runtime-Dependencies (aktuell nur ftfy).

Dev-Dependencies mitinstallieren

make install-dev

Installiert zusaetzlich pytest und ruff fuer Tests und Linting.

Git-Hooks aktivieren

make git-setup

Aktiviert den Conventional-Commits-Hook und das Commit-Message-Template. Ab diesem Zeitpunkt wird jede Commit-Message beim git commit automatisch validiert.

Pruefen ob alles funktioniert

make test

Erwartet: 132 Tests bestanden, keine Fehler.

Projektstruktur nach der Installation

manuscript-tools/
├── src/manuscript_tools/    # Library-Code
│   ├── models.py            # Datenklassen
│   ├── io.py                # Datei-Discovery
│   ├── config.py            # Projekt-Konfiguration via pyproject.toml
│   ├── checker.py           # Style-Validierung (9 Regeln)
│   ├── sanitizer.py         # Textbereinigung
│   ├── quotes.py            # Deutsche Anfuehrungszeichen
│   ├── formatting.py        # Gebrochene Bold/Italic-Formatierung
│   ├── metrics.py           # Wortzaehlung, Lesbarkeit, Flesch-DE
│   └── cli.py               # CLI-Einstiegspunkte
├── tests/                   # 132 Tests
├── scripts/                 # Hilfsskripte
│   └── bump_version.py      # Version-Bump (sync pyproject.toml + __init__.py)
├── .githooks/               # Commit-Message-Validierung
├── .gitmessage              # Commit-Template
├── Makefile                 # Task-Runner
├── pyproject.toml           # Poetry-Konfiguration
├── LICENSE                  # BSD 3-Clause
├── README.md                # Englisch
└── README.de.md             # Deutsch

---

Weiter: Verwendung