Installation

This page covers the installation of DipDup in different environments.

Host requirements

A Linux/macOS environment with Python 3.11 installed is required to use DipDup. Also, you need a basic Python environment for the install script, python3.11 -m ensurepip. Apple silicon is supported. Other UNIX-like systems should work but are not supported officially. If you use Windows, please use WSL or Docker.

Minimum hardware requirements are 256 MB RAM, 1 CPU core, and some disk space for the database. RAM requirements increase with the number of indexes.

Local installation

Interactively

The easiest way to install DipDup is to use our interactive installer script. It will ask you a few questions and install DipDup with all dependencies. Run the following command in your terminal:

curl -Lsf https://dipdup.io/install.py | python3

That's it! DipDup is installed as a CLI application and is available everywhere in a system. Now you can run dipdup new to spawn a new project from lots of ready-to-use templates and proceed to the next section: Core concepts

From scratch

If you don't want to use our installer, you can install DipDup manually. You can use any Python package manager you like, but we recommend PDM.

First, create a new project directory and enter it:

mkdir dipdup_indexer; cd dipdup_indexer

Then use the snippets below to create a new Python project and add DipDup as a dependency.

PDM (recommended)

PDM is a very powerful package manager with a lot of features. Also, it can run scripts from pyproject.toml as npm does. It's a good choice for both beginners and advanced users. Some commands are hard to remember though.

pdm init --python 3.11 --lib  # use "">=3.11,<3.12" for requires-python
pdm venv create
pdm add "dipdup>=7,<8" --venv
$(pdm venv activate)

Poetry

Poetry is another popular tool to manage Python projects. It doesn't support scripts and resolving is slower in some cases, but in all other aspects, it's a great tool!

poetry init --python ">=3.11,<3.12"
poetry add "dipdup>=7,<8"
poetry shell

pip

Finally, if you prefer to do everything manually, you can use pip. It's the most basic package manager, but it's developed by the Python core team and is very stable.

python -m venv .venv
. .venv/bin/activate
echo "dipdup>=7,<8" >> requirements.txt
pip install -r requirements.txt -e .

Docker

For Docker installation, please refer to the Docker page.