Guide¶
This guide will help you build and ship a Python library like the one in this repository. It walks you through the basics of version control, the collaborative workflow, the packaging and testing, and the linguistic knowledge that goes inside.
Guide, not reference
These pages teach the how. The Library section is
the other half of this site: the reference manual of esperantilo itself —
its API and its functionality.
The four sections¶
- 1. Git — version control: how it works, the commands you need, and how to undo things.
- 2. GitHub — the collaborative workflow: pull requests, Actions, repository protection, Pages.
- 3. Python Library — packaging, layout, API design, installation and testing.
- 4. Esperanto — history, grammar, vocabulary and word lists: the rules the library encodes.
The sections are mostly independent. Read them in order if you are starting from scratch; jump straight to Python Library or Esperanto if you already know Git and GitHub.
This repository is the worked example¶
Wherever the guide shows a file, a workflow or a commit, it is a real one from this repository — not an invented snippet. The Library section documents the result.
| The guide explains | You can see it running in |
|---|---|
pyproject.toml and the src/ layout |
pyproject.toml |
| Designing a public API | Library → API reference |
| Writing tests | tests/test_tokenizer.py |
| GitHub Actions | .github/workflows/ |
| GitHub Pages | this site |