Environment & Development

Prerequisites

  • pixi
  • WSL (required for Windows users to utilize Quarto)

Environment Setup

Local Environment

  1. Clone repository
git clone https://github.com/jakepenzak/caml
  1. Change directory (cd) into project root then create your pixi environments:
pixi install
pixi install --environment dev
pixi install --environment dev-polars
pixi install --environment dev-pandas
pixi install --environment dev-pyspark
  1. Activate you pixi shell for dev environment
pixi shell --environment dev
  1. Initialize pre-commit hooks via pre-commit install

  2. Edit & test code locally (as applicable)

Please refer to the pixi documentation for modifying dependencies and any other pixi related questions.

Committing & Pull Requests

  • Try best to follow commit message conventions outlined here
  • On PRs, please fill out the generated PR template. As of now, there are two github actions that will be triggered on pull request & will be required to run successfully in order to merge:
    1. CI/CD pipeline (.github/workflows/ci.yml) through dev & tst environments (see Running bundle job via Github Actions for more details)
    2. Testing & updating coverage badge (.github/workflows/testing.yml)
Back to top