Skip to content

Installation

M42PL is divided into several packages and repositories. If you're starting on the project, you may prefer to use a container image.

For more experienced users and developers, you may install the project from source.

Container images

Two container images are available:

  • jpclipffel/m42pl: standard image, comes with everything pre-installed
docker pull jpclipffel/m42pl:latest
# Or
docker pull ghcr.io/jpclipffel/m42pl:latest
  • jpclipffel/m42pl-core: base image, contains only m42pl-core
docker pull jpclipffel/m42pl-core:latest
# Or
docker pull ghcr.io/jpclipffel/m42pl-core:latest

From source

M42PL is built on several components (core, commands, dispatchers, kvstores and encoders).

Installation in a virtual environment

If is recomended to install M42PL into a dedicated virtual environement: python -m venv m42pl && source m42pl/bin/activate

Installation in development mode

If you plan to make change to M42PL, install the component(s) with pip install -e <component>

Install the core project m42pl_core:

git clone https://github.com/jpclipffel/m42pl-core
pip install m42pl-core

Install the core commands m42pl_commands:

git clone https://github.com/jpclipffel/m42pl-commands
pip install m42pl-commands

Install the core dispatchers m42pl_dispatchers:

git clone https://github.com/jpclipffel/m42pl-dispatchers
pip install m42pl-dispatchers

Install the core kvstores m42pl_kvsotres:

git clone https://github.com/jpclipffel/m42pl-kvstores
pip install m42pl-kvstores

Install the core encoders m42pl_encoders:

git clone https://github.com/jpclipffel/m42pl-encoders
pip install m42pl-encoders