https://github.com/datalab-org/datalab-app-plugin-template
A template for app plugins that implement custom data blocks for datalab.
https://github.com/datalab-org/datalab-app-plugin-template
datalab datalab-plugin
Last synced: 5 months ago
JSON representation
A template for app plugins that implement custom data blocks for datalab.
- Host: GitHub
- URL: https://github.com/datalab-org/datalab-app-plugin-template
- Owner: datalab-org
- License: mit
- Created: 2024-10-21T13:20:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-19T15:19:40.000Z (10 months ago)
- Last Synced: 2025-09-11T10:49:51.975Z (9 months ago)
- Topics: datalab, datalab-plugin
- Language: Jinja
- Homepage:
- Size: 61.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/datalab-org/datalab-app-plugin-template/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen) or contact us via the routes listed at [datalab-org](https://github.com/datalab-org).
This template uses [Copier](https://github.com/copier-org/copier).
We recommend using `uv` to manage Python versions and environments, in which case the template can be used with:
```shell
mkdir my_plugin
uvx copier copy "git@github.com:datalab-org/datalab-app-plugin-template"
```
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):
```shell
cd
uv lock
git init
git add .
git commit -m "Initial commit"
git remote add origin
```
You can also occasionally sync changes from this template by running the following command in your plugin repository:
```shell
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](https://github.com/datalab-org/datalab-app-plugin-example).