Contributing

Setup

git clone https://github.com/MaxHalford/prince
cd prince
poetry install
poetry shell

Install the pre-commit push hooks. This will run some code quality checks every time you push to GitHub.

pre-commit install --hook-type pre-push

You can optionally run pre-commit at any time as so:

pre-commit run --all-files

Some unit tests call the FactoMineR package via rpy2; you have to install it:

Rscript -e 'install.packages("FactoMineR", repos="https://cloud.r-project.org")'

pytest

make execute-notebooks
make render-notebooks
(cd docs && hugo serve)

gh workflow run hugo.yml

poetry publish --build