https://github.com/stencila/plugin-python-template

Template repo for creating a Stencila plugin written in Python
https://github.com/stencila/plugin-python-template

Last synced: about 1 year ago
JSON representation

Template repo for creating a Stencila plugin written in Python

• Host: GitHub
• URL: https://github.com/stencila/plugin-python-template
• Owner: stencila
• License: apache-2.0
• Created: 2024-02-21T20:54:33.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T14:45:39.000Z (about 2 years ago)
• Last Synced: 2024-05-22T06:42:22.090Z (about 2 years ago)
• Language: Python
• Homepage:
• Size: 91.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Template for a Stencila Python Plugin

This repository provides a starting point for writing a Stencila plugin in Python.

It contains a standard python setup, including:

- [Poetry](https://python-poetry.org) for package management.

- The required dependencies from Stencila ([types](https://pypi.org/project/stencila_types/) and [plugin](https://pypi.org/project/stencila_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.