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]>
narwhals-dev · Oct 17, 2024 · 736a360 · 736a360
1 parent 741e66d
commit 736a360
Showing 1 changed file with 23 additions and 7 deletions.
diff --git a/docs/installation.md b/docs/installation.md
@@ -2,20 +2,36 @@
 
 ## Installation
 
-First, make sure you have [created and activated](https://docs.python.org/3/library/venv.html) a Python3.8+ virtual environment.
+=== "UV"
 
-Then, run
-```console
-python -m pip install narwhals
-```
+    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.
+
+    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.
+    Then, run:
+
+    ```console
+    uv pip install narwhals
+    ```
+
+=== "Python's venv"
+
+    First, ensure you have [created and activated](https://docs.python.org/3/library/venv.html) a Python 3.8+ virtual environment.
+
+    Then, run:
+
+    ```console
+    python -m pip install narwhals
+    ```
+
+### Verifying the Installation
 
-Then, if you start the Python REPL and see the following:
+To verify the installation, start the Python REPL and execute:
 ```python
 >>> import narwhals
 >>> narwhals.__version__
 '1.9.4'
 ```
-then installation worked correctly!
+If you see the version number, then the installation was successful!
 
 ## Quick start