|
6 | 6 | [](#development) |
7 | 7 | [](LICENSE) |
8 | 8 |
|
9 | | -Pylings is a Rustlings-style learning environment for Python. It ships broken |
10 | | -exercises, hidden checks, a live Textual editor, progressive hints, and bundled |
| 9 | +Rustlings-style interactive Python exercises in a live terminal TUI. |
| 10 | + |
| 11 | +Pylings helps you learn Python by fixing small broken programs and watching |
| 12 | +checks rerun as you type. It is built for beginner Python practice, coding |
| 13 | +practice, and self-paced Python tutorial workflows: 292 exercises, hidden |
| 14 | +pytest-style checks, a live Textual editor, progressive hints, and bundled |
11 | 15 | Python documentation snippets so learners can work without leaving the terminal. |
12 | 16 |
|
13 | 17 |  |
14 | 18 |
|
15 | 19 | ## Highlights |
16 | 20 |
|
17 | | -- 292 exercises across 31 Python topics, from variables through async. |
| 21 | +- 292 Python exercises across 31 topics, from variables through async. |
| 22 | +- Rustlings-inspired learn-by-doing flow for Python coding practice. |
18 | 23 | - Live in-terminal editor with automatic checks after edits. |
19 | 24 | - Topic picker with progress, resume state, reset, hints, and one-shot CLI runs. |
20 | 25 | - `F5` opens a local Python reference window; `O` opens the official docs page. |
21 | 26 | - Bundled docs are generated from the official Python documentation for offline use. |
22 | 27 |
|
23 | 28 | ## Install |
24 | 29 |
|
| 30 | +The `pylings` command is installed from this repository. The PyPI project name |
| 31 | +`pylings` is already used by another package, so install this project from |
| 32 | +GitHub until a package release is published under its distribution name, |
| 33 | +`pylings-tui`. |
| 34 | + |
25 | 35 | ```bash |
26 | | -pipx install pylings |
| 36 | +pipx install git+https://github.com/abhiksark/pylings.git |
27 | 37 | ``` |
28 | 38 |
|
29 | 39 | For local development: |
|
0 commit comments