Skip to content

Commit a6567e3

Browse files
authored
Merge pull request #19 from abhiksark/dev
docs: fix README install/badges/hero for the live PyPI release (#5, #6, #7)
2 parents fa9c530 + 2336ddb commit a6567e3

1 file changed

Lines changed: 36 additions & 16 deletions

File tree

Readme.md

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,33 @@
11
# Pylings
22

3-
[![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-3776AB)](https://www.python.org/)
4-
[![Version](https://img.shields.io/badge/version-0.1.0-blue)](https://semver.org/)
5-
[![SemVer](https://img.shields.io/badge/semver-2.0.0-brightgreen)](https://semver.org/)
6-
[![Tests](https://img.shields.io/badge/tests-125%20passing-brightgreen)](#development)
3+
[![PyPI](https://img.shields.io/pypi/v/python-learnings)](https://pypi.org/project/python-learnings/)
4+
[![Python](https://img.shields.io/pypi/pyversions/python-learnings)](https://pypi.org/project/python-learnings/)
5+
[![CI](https://github.com/abhiksark/pylings/actions/workflows/ci.yml/badge.svg)](https://github.com/abhiksark/pylings/actions/workflows/ci.yml)
6+
[![Downloads](https://img.shields.io/pypi/dm/python-learnings)](https://pypi.org/project/python-learnings/)
77
[![License: MIT](https://img.shields.io/badge/license-MIT-yellow)](LICENSE)
88

99
Documentation: [pylings.abhik.ai](https://pylings.abhik.ai/)
1010

11-
Python learnings, Rustlings-style, in a live terminal TUI.
11+
**Rustlings for Python — learn by fixing 292 tiny broken programs in your terminal.**
1212

1313
Pylings helps you learn Python by fixing small broken programs and watching
1414
checks rerun as you type. It is built for beginner Python practice, coding
1515
practice, and self-paced Python tutorial workflows: 292 exercises, hidden
1616
pytest-style checks, a live Textual editor, progressive hints, and bundled
1717
Python documentation snippets so learners can work without leaving the terminal.
1818

19-
Status: `v0.1.0` alpha. GitHub installs are available now; the PyPI package
20-
name is `python-learnings` and will become the primary install path after
21-
publishing is enabled.
19+
**Try it in 10 seconds** — zero install, needs [Python 3.9+](https://www.python.org/downloads/)
20+
and [uv](https://docs.astral.sh/uv/):
21+
22+
```bash
23+
uvx --from python-learnings pylings init --path ./learn-python
24+
cd learn-python && uvx --from python-learnings pylings
25+
```
26+
27+
How it works: **edit** the broken exercise in your own editor → **save**
28+
checks rerun and advance you to the next one. That's the whole loop.
29+
30+
Status: `v0.2.0`, alpha — published on PyPI as `python-learnings`.
2231

2332
![Coding screen](docs/assets/screenshots/coding-screen.png)
2433

@@ -50,26 +59,37 @@ publishing is enabled.
5059

5160
## Install
5261

53-
Install the current release directly from GitHub:
62+
Pylings is on PyPI as **`python-learnings`** (it installs the `pylings`
63+
command). You need [Python 3.9+](https://www.python.org/downloads/).
64+
65+
Recommended — install it isolated, like any CLI app:
5466

5567
```bash
56-
pipx install "git+https://github.com/abhiksark/pylings.git@v0.1.0"
68+
pipx install python-learnings
69+
# or
70+
uv tool install python-learnings
5771
```
5872

59-
After PyPI publishing is enabled, the package install will be:
73+
Or run it with no install at all:
6074

6175
```bash
62-
pipx install python-learnings
76+
uvx --from python-learnings pylings
77+
```
78+
79+
Or plain pip (use a virtual environment):
80+
81+
```bash
82+
pip install python-learnings
6383
```
6484

65-
The `pylings` command is installed by the `python-learnings` package. The PyPI
66-
project name `pylings` is already used by another package, so do not use
67-
`pip install pylings` for this project.
85+
> The PyPI **name** is `python-learnings`; the **command** is `pylings`. The
86+
> name `pylings` on PyPI belongs to a different project, so do **not** run
87+
> `pip install pylings`.
6888
6989
For the latest development build from `main`:
7090

7191
```bash
72-
pipx install --force git+https://github.com/abhiksark/pylings.git
92+
pipx install --force "git+https://github.com/abhiksark/pylings.git"
7393
```
7494

7595
Create a learner workspace before starting:

0 commit comments

Comments
 (0)