Skip to content

Commit 736a360

Browse files
luke396FBruzzesi
andauthored
docs: Add uv to quick start (#1169)
* doc: Add uv to quick start * Update docs/installation.md Co-authored-by: Francesco Bruzzesi <[email protected]> * docs: update with content tab * docs: enhance installation instructions for UV and Python's venv * Update docs/installation.md Co-authored-by: Francesco Bruzzesi <[email protected]> --------- Co-authored-by: Francesco Bruzzesi <[email protected]>
1 parent 741e66d commit 736a360

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

docs/installation.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,36 @@
22

33
## Installation
44

5-
First, make sure you have [created and activated](https://docs.python.org/3/library/venv.html) a Python3.8+ virtual environment.
5+
=== "UV"
66

7-
Then, run
8-
```console
9-
python -m pip install narwhals
10-
```
7+
First, ensure you have installed [UV](https://github.com/astral-sh/uv), and make sure you have [created and activated](https://docs.astral.sh/uv/pip/environments/#python-environments) a Python 3.8+ virtual environment.
8+
9+
If you haven't, you can follow our [_setting up your environment_](https://github.com/narwhals-dev/narwhals/blob/main/CONTRIBUTING.md#option-1-use-uv-recommended) guide.
10+
Then, run:
11+
12+
```console
13+
uv pip install narwhals
14+
```
15+
16+
=== "Python's venv"
17+
18+
First, ensure you have [created and activated](https://docs.python.org/3/library/venv.html) a Python 3.8+ virtual environment.
19+
20+
Then, run:
21+
22+
```console
23+
python -m pip install narwhals
24+
```
25+
26+
### Verifying the Installation
1127

12-
Then, if you start the Python REPL and see the following:
28+
To verify the installation, start the Python REPL and execute:
1329
```python
1430
>>> import narwhals
1531
>>> narwhals.__version__
1632
'1.9.4'
1733
```
18-
then installation worked correctly!
34+
If you see the version number, then the installation was successful!
1935

2036
## Quick start
2137

0 commit comments

Comments
 (0)