Thank you for your interest in contributing to Narwhals! Any kind of improvement is welcome!
Here's how you can set up your local development environment to contribute:
- Make sure you have Python3.9+ installed
- Create a new virtual environment with
python3.11 -m venv .venv(or whichever version of Python3.9+ you prefer) - Activate it:
. .venv/bin/activate - Install Narwhals:
pip install -e . - Install test requirements:
pip install -r requirements-dev.txt - Install docs requirements:
pip install -r docs/requirements-docs.txt
To run tests, run pytest. To check coverage: pytest --cov=narwhals.
To build the docs, run mkdocs serve, and then open the link provided in a browser.
The docs should refresh when you make changes. If they don't, press ctrl+C, and then
do mkdocs build and then mkdocs serve.
Please remember to abide by the code of conduct, else you'll be conducted away from this project.