Get Started

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

Installing with pip (recommended)

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. First, you will need to install poetry. poetry is used to manage and install the dependencies. If poetry is already installed on your machine, you can skip this step. There are several ways to install poetry so you can use the one that you prefer. You can check the poetry installation by running the following command:

poetry --version

Then, you can clone the git repository:

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

It is recommended to create a Python 3.8+ virtual environment. This step is optional so you can skip it. To create a virtual environment, you can use the following command:

make conda

It automatically creates a conda virtual environment. When the virtual environment is created, you can activate it with the following command:

conda activate minevent

This example uses conda to create a virtual environment, but you can use other tools or configurations. Then, you should install the required package to use minevent with the following command:

make install

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:

make unit-test-cov