Getting started#

Before downloading the template, the following installations are required:

  • git

  • an installed version of Python (minimum required version is 3.9);

  • hatch

The recomended development environment is VSCode. The template provides a pre-shipped configuration with the standard tooling used accross the Redsun ecosystem.

Setup environment#

First, create the folder which will contain your plugin. In this example, we’ll use the name my-plugin, but feel free to chose any other name.

mkdir my-plugin

Then, create a virtual environment and activate it.

# python version depends
# on the globally installed python
python -m venv my-plugin

# for Windows, you'll need to use
# Activate.ps1
venv\scripts\Activate

conda create -n my-plugin python=3.9
conda activate my-plugin

mamba create -n my-plugin python=3.9
mamba activate my-plugin

In your currently active environment, install the following dependencies via pip:

python -m pip install copier copier-templates-extensions jinja2-time

Download the template#

In your active environment, generate a new Redsun plugin with the following command:

# "my-plugin" is the name of your plugin folder;
# change it accordingly
copier copy --trust https://github.com/redsun-acquisition/redsun-plugin-template my-plugin

At this point, follow the command line prompts to generate your plugin.