jtschichold/minemeld-sample-extension

Work in progress, move along.

minemeld-sample-extension

Sample Extension for MineMeld (10.0a1 and later)

Introduction

Extensions for MineMeld are basically Python3 packages that could include:

• new node classes
• new prototypes
• new UI components
• new API

This simple extension only includes a new node class and a new prototype.

Dynamic discovery

MineMeld engine discovers prototypes and node classes using setuptools entry points. The entry points are listed in the file minemeld.json that should exist in the root of the extension:

• minemeld_nodes is the list of node classes provided by the extension
• minemeld_prototypes is the list of prototype libraries provided by the extension

Installation

The easiest way to install the extension is using pip3 in the virtual environment of the MineMeld engine, check the Dockerfile for an example. The Dockerfile requires a minemeld:test image built from the MineMeld Python3 Dockerfile.

Build & Run the docker image

To build the MineMeld engine docker image with the extension: docker build --force-rm -t minemeld:sample_extension -f docker/Dockerfile .

To run it: docker-compose -f docker/docker-compose.yml up