Skip to content

Commit

Permalink
show python-venv alternative
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcoGorelli committed Aug 29, 2024
1 parent ebd1d78 commit a316978
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit a316978

Please sign in to comment.