Skip to content
Snippets Groups Projects

Setting up a new plugin

In the following, $NAME refers to the plugin name, and $URL refers to the git repo link where your new plugin will reside (n.b. NOT this template repo)

  • Clone this template into an appropriate directory, with this upstream repo named "template":
    $ git clone -o template https://git.uclalemur.com/mehtank/roco-template.git $NAME
    $ cd $NAME
  • Unlink new clone from template repo and instead link to new upstream:
    $ git config --unset branch.main.remote
    $ git remote add origin $URL
  • Set up new folder path:
    $ git mv plugin $NAME
    $ sed -i "s/pkg_path = \"plugin\"/pkg_path = '$NAME'/" setup.py
    $ cd $NAME
  • Define new plugin metadata (assuming $EDITOR is correctly set to your text editor of choice):
    $ sed -i "s/__plugin_name__ = 'template'/__plugin_name__ = '$NAME'/" __init__.py
    $ sed -i "s#__url__ = 'https://git.uclalemur.com/roco/roco-template'#__url__ = '$URL'#" __init__.py
    $ $EDITOR __init__.py # then edit this file with an appropriate description
    $ git commit -am "Configured template for $NAME plugin"