You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/installation.md
+23-7Lines changed: 23 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,36 @@
2
2
3
3
## Installation
4
4
5
-
First, make sure you have [created and activated](https://docs.python.org/3/library/venv.html) a Python3.8+ virtual environment.
5
+
=== "UV"
6
6
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
11
27
12
-
Then, if you start the Python REPL and see the following:
28
+
To verify the installation, start the Python REPL and execute:
13
29
```python
14
30
>>>import narwhals
15
31
>>> narwhals.__version__
16
32
'1.9.4'
17
33
```
18
-
then installation worked correctly!
34
+
If you see the version number, then the installation was successful!
0 commit comments