Skip to content

Get Started

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

We highly recommend installing a virtual environment. minevent can be installed from pip using the following command:

pip install minevent

To make the package as slim as possible, only the minimal packages required to use minevent are installed. To include all the dependencies, you can use the following command:

pip install minevent[all]

Installing from source

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

Prerequisites

This project uses uv for dependency management. If you don't have uv installed, you can install it by following the official installation guide.

Clone the repository

First, clone the git repository:

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

It is recommended to create a Python 3.10+ virtual environment. You can use uv to create a virtual environment:

uv venv --python 3.13
source .venv/bin/activate

Install dependencies

Once you have activated your virtual environment, install the required packages with:

inv install

Or if you're developing and need documentation dependencies:

inv install --docs-deps

These commands will install all the required packages. You can also use these commands to update the required packages.

Verify the installation

Finally, you can test the installation by running the test suite:

inv unit-test --cov

Development workflow

If you're planning to contribute to minevent, please refer to the Contributing Guide for more information on setting up your development environment and running tests.