From a3169786cbe15f75a446ec3d96dd54ea3a153b7a Mon Sep 17 00:00:00 2001 From: Marco Gorelli <33491632+MarcoGorelli@users.noreply.github.com> Date: Thu, 29 Aug 2024 13:58:37 +0200 Subject: [PATCH] show python-venv alternative --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbc3af530..2ed34a9ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,6 +49,8 @@ git clone git@github.com:YOUR-USERNAME/narwhals.git Here's how you can set up your local development environment to contribute. +#### Option 1: Use UV (recommended) + 1. Make sure you have Python3.8+ installed (for example, Python 3.11), create a virtual environment, and activate it. If you're new to this, here's one way that we recommend: 1. Install uv: https://github.com/astral-sh/uv?tab=readme-ov-file#getting-started @@ -73,6 +75,14 @@ pre-commit install ``` This will automatically format and lint your code before each commit, and it will block the commit if any issues are found. +#### Option 2: use python3-venv + +1. Make sure you have Python 3.8+ installed. If you don't, you can check [install Python](https://realpython.com/installing-python/) + to learn how. Then, [create and activate](https://realpython.com/python-virtual-environments-a-primer/) + a virtual environment. + +Then, follow steps 2-4 from above but using `pip install` instead of `uv pip install`. + ### 5. Working on your issue Create a new git branch from the `main` branch in your local repository.