Installation

with pip recommended

Irene-Sankey is published as a python package and can be installed with pip, ideally by using a virtual environment. Open up a terminal and install Irene-Sankey with:

Latest1.x

pip install irene-sankey

pip install irene-sankey=="1.*" # (1)!

Irene-Sankey uses semantic versioning.

This will make sure that you don't accidentally [upgrade to the next major version], which may include breaking changes that silently corrupt your site. Additionally, you can use pip freeze to create a lockfile, so builds are reproducible at all times:
```
pip freeze > requirements.txt
```
Now, the lockfile can be used for installation:
```
pip install -r requirements.txt
```

This will automatically install compatible versions of all dependencies: numpy, pandas, plotly, and requests. Irene-Sankey always strives to support the latest versions, so there's no need to install those packages separately.

Tip

If you don't have prior experience with Python, we recommend reading Using Python's pip to Manage Your Projects' Dependencies, which is a really good introduction on the mechanics of Python package management and helps you troubleshoot if you run into errors.

with git

Irene-Sankey can be directly used from GitHub by cloning the repository into a subfolder of your project root which might be useful if you want to use the very latest version:

git clone https://github.com/fox-techniques/irene-sankey.git

Next, install the theme and its dependencies with:

pip install -e irene-sankey

with poetry

Prerequisites:

Python 3.8 or higher
Poetry

Installing Irene-Sankey:

poetry add irene-sankey

This command downloads and installs the package and its dependencies and adds the package as a dependency in your pyproject.toml.

Using the Package:

After installation, you can start using the package in your project. If you need to enter the virtual environment managed by Poetry, run:

poetry shell

Verify the Installation:

poetry show irene-sankey

Updating the Package:

poetry update irene-sankey