Important
Stencila's plugin system has been deprecated in favor of support for the Model Context Protocol and this repository has been achived. For more details see this PR.
This repository provides a starting point for writing a Stencila plugin in Python. It contains a standard python setup, including:
- Poetry for package management.
- The required dependencies from Stencila (types and plugin)
- Implementation of the Kernel API that simply echoes the input.
- A set of tests that can be run using
pytest.
To use this repository as a starting point for your own plugin:
- Look for [use this template] on GitHub, and follow instructions.
- Change the folder name under
srcto your chosen name. - Update the
pyproject.tomlfile to reflect your package name, description, and author. - Update the
tests/conftest.pyfile to reflect the location of the plugin script.