Get Started

We highly recommend installing docculus in a virtual environment to avoid dependency conflicts.

Using uv (recommended)

uv is a fast Python package installer and resolver:

uv pip install docculus

Install with all optional dependencies:

uv pip install docculus[all]

Install with specific optional dependencies:

uv pip install "docculus[duckdb]"

Using pip

Alternatively, you can use pip:

pip install docculus

Install with all optional dependencies:

pip install docculus[all]

Install with specific optional dependencies:

pip install "docculus[duckdb]"

Installing from source

To install docculus from source, you can follow the steps below.

First, clone the git repository:

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

Note: docculus requires Python 3.10 or higher.

It is recommended to create a virtual environment (this step is optional). To create a virtual environment, you can use the following command:

make setup-venv

This command automatically creates a virtual environment using uv. When the virtual environment is created, you can activate it with the following command:

source .venv/bin/activate

Then, you should install the required packages to use docculus with the following command:

inv install --docs-deps

This command will install all the required packages. You can also use this command to update the required packages. This command will check if there is a more recent package available and will install it. Finally, you can test the installation with the following command:

inv unit-test --cov