Skip to main content

Installation

Prerequisites​

Eventum requires Python 3.11 or later version to be installed.

Supported platforms are Windows, Linux and MacOS.

Components​

Eventum includes next components:

  • Eventum CLI - command line interface for running the generator
  • Eventum Studio - web application for content designing

Installation​

To install Eventum CLI:

pipx install eventum-cli

To install Eventum Studio:

pipx install eventum-studio

Using Pip​

Create virtual environment (optionally)​

For Windows users:

cd %HOMEPATH%
python -m venv venv
venv\Scripts\activate

For Linux and MacOS users:

cd
python3 -m venv venv
source venv/bin/activate

Install package​

To install Eventum CLI:

pip install eventum-cli

To install Eventum Studio:

pip install eventum-studio

From source​

Installation using source code requires Poetry to be installed.

Clone the repository​

To clone Eventum CLI repo:

git clone https://github.com/eventum-project/eventum-cli.git
cd EventumCLI

To clone Eventum Studio repo:

git clone https://github.com/eventum-project/eventum-studio.git
cd EventumStudio

Install dependencies​

Install dependencies individually for each project:

poetry install
poetry shell

Ensure installation​

To ensure that components are installed properly, check the version using following commands.

For Eventum CLI:

eventum --version

For Eventum Studio:

eventum-studio --version