letsql 0.1.0

No project description provided

LETSQL

Contributing Guide

Setting up a development environment

This assumes that you have rust and cargo installed. We use the workflow recommended by pyo3 and maturin.

# fetch this repo
git clone [e-mail]:letsql/letsql.git
# prepare development environment (used to build wheel / install in development)
python3 -m venv venv
# activate the venv
source venv/bin/activate
# update pip itself if necessary
python -m pip install -U pip
# install dependencies (for Python 3.8+)
python -m pip install -r requirements-dev.txt
# set up the git hook scripts
pre-commit install

Running the test suite

Install the just command runner, if needed. Download example data to run the tests successfully.

just download-data

Start the postgresql server:

just up

To test the code:

# make sure you activate the venv using "source venv/bin/activate" first
maturin develop
python -m pytest # or pytest