Development

Thanks for deciding to work on dataframely! You can create a development environment with the following steps:

Install Tooling

To work on dataframely, you’ll need to install

• pixi to manage the Python environment

• rustup to manage the Rust toolchain for compiling dataframely

Environment Installation

git clone https://github.com/Quantco/dataframely
cd dataframely
rustup show
pixi install

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

pixi run postinstall
pixi run pre-commit-install

Running the tests

pixi run test

You can adjust the tests/ path to run tests in a specific directory or module.

Documentation

We use Sphinx together with MyST, and write user documentation in markdown. If you are not yet familiar with this setup, the MyST docs for Sphinx are a good starting point.

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:

# Run build
pixi run -e docs postinstall
pixi run docs

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