Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Template repo for creating a Stencila plugin written in Python

License

Notifications You must be signed in to change notification settings

stencila/plugin-python-template

Repository files navigation

Template for a Stencila Python Plugin

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 src to your chosen name.
  • Update the pyproject.toml file to reflect your package name, description, and author.
  • Update the tests/conftest.py file to reflect the location of the plugin script.

About

Template repo for creating a Stencila plugin written in Python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages