Skip to content

Get Started

It is highly recommended to install in a virtual environment to keep your system in order.

The following command installs the latest version of the library:

pip install feu

To make the package as slim as possible, only the packages required to use feu are installed. It is possible to install all the optional dependencies by running the following command:

pip install 'feu[all]'

It is also possible to install specific optional dependencies:

  • feu[cli] - Install CLI support (click)
  • feu[git] - Install git support (gitpython)
  • feu[requests] - Install HTTP request support (requests, urllib3)

For example:

pip install 'feu[cli,git]'

Installing from source

To install feu from source, you can follow the steps below. First, you will need to install uv. uv is a fast Python package installer and resolver used to manage dependencies in this project.

You can install uv using:

# On macOS and Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Or with pip
pip install uv

Then, clone the git repository:

git clone git@github.com:durandtibo/feu.git
cd feu

It is recommended to create a Python 3.10+ virtual environment. The easiest way is to use the provided Makefile command:

make setup-venv

This command automatically: 1. Updates uv to the latest version 2. Creates a Python 3.13 virtual environment 3. Installs invoke task runner 4. Installs all dependencies including development and documentation dependencies

Alternatively, you can manually set up the environment:

# Create a virtual environment with uv
uv venv --python 3.13

# Activate the virtual environment
source .venv/bin/activate

# Install the package with all dependencies
uv sync --all-extras --group dev --group docs

After installation, you can verify everything is working by running the tests:

inv unit-test --cov