Skip to content

Plugin Packaging

A Karrot plugin is simply a zipped directory containing the plugin files.

example-plugin/
├── backend
│   ├── apps.py
│   ├── __init__.py
│   ├── urls.py
│   └── views.py
└── frontend
    ├── assets
    │   ├── app.css
    │   └── app.js
    └── manifest.json

We don't currently provide any tooling for doing this, but you should ensure:

  • you don't include __pycache__ entries
  • don't include .git directory
  • ... or any other extraneous files

If you are using a vite-based frontend plugin as recommended, you only need to include the dist/ folder that it creates.