datalab-app-plugin-template

Warning

This repository is still under active development and will have some rough edges. Please raise any issues in the Issue Tracker or contact us via the routes listed at datalab-org.

This template uses Copier.

We recommend using uv to manage Python versions and environments, in which case the template can be used with:

mkdir my_plugin
uvx copier copy "[email protected]:datalab-org/datalab-app-plugin-template" <my_plugin>

This will guide you through the process of creating a new repository for your plugin. You can commit the result, alongside the .copier-answers.yml file, to your new repository (after creating it on GitHub or elsewhere):

cd <my_plugin>
uv lock
git init
git add .
git commit -m "Initial commit"
git remote add origin <your-repo-url>

You can also occasionally sync changes from this template by running the following command in your plugin repository:

uvx copier update

Releases of the plugin are created via semantic version tags on GitHub, and will require manually updating the CHANGELOG.md file.

An example use of this repository can be found at datalab-app-plugin-example.