Installing#
Warning
skrub has not yet been released. See the “From source” tab.
Warning
skrub has not yet been released. See the “From source” tab.
Warning
skrub has not yet been released. See the “From source” tab.
Recommended usage, for users#
To install from the source using pip, run the following command in a shell command line:
$ pip install git+https://github.com/skrub-data/skrub.git
Advanced usage, for contributors#
If you want to contribute to the project, you can install the development version of skrub from the source code:
$ git clone https://github.com/skrub-data/skrub
Create a virtual environment, here for example, using conda:
$ conda create -n skrub python=3.10
$ conda activate skrub
Then, install the local package in editable mode, with the development requirements:
$ cd skrub
$ pip install -e '.[dev]'
Next step, enable the pre-commit hooks:
$ pre-commit install
Finally, a few revisions better be ignored by git blame
and IDE integrations.
These revisions are listed in .git-blame-ignore-revs
,
which can be set in your local repository with:
$ git config blame.ignoreRevsFile .git-blame-ignore-revs
You’re ready to go! If not already done, please have a look at the contributing guidelines.