Development

Thanks for deciding to work on sqlcompyre! You clone the repository with the following steps:

git clone https://github.com/quantco/sqlcompyre
cd sqlcompyre

Next make sure to install the package locally and set up pre-commit hooks:

pixi run pre-commit-install
pixi run postinstall

All tests for this project currently require running an MSSQL server via Docker. You need to have Docker installed to do this.

docker compose up

Make sure you also have msodbcsql18 installed, or install it here, you might also need to set the environment variable ODBCSYSINI to the directory where msodbcsql18 is installed.

Then, run the tests as below:

pixi run test

When updating the documentation, you can compile a localized build of the documentation and then open it in your web browser using the commands below:

pixi run docs

# Open documentation
open docs/_build/html/index.html