# Stencila Plugin
[![stencila_plugin](https://img.shields.io/pypi/v/stencila_plugin.svg?logo=python&label=stencila_plugin&style=for-the-badge&color=1d3bd1&logoColor=66ff66&labelColor=3219a8)](https://pypi.org/project/stencila_plugin/)
## Introduction
This package provides tools for writing a [Stencila](https://github.com/stencila/stencila) plugin.
Stencila plugins extend the functionality of Stencila, and are dynamically loaded at runtime.
They communicate with the core Stencila app via JSON-RPC over a port, or via stdin/stdout.
This package implements much of the core functionality for communication, and makes writing a plugin as simple as filling out a few python functions.
## ⚡ Usage
The plugin can be installed via `pip`.
`pip install stencila_plugin`
An example of how to write a plugin can be seen in this [repo](https://github.com/stencila/plugin-example-python).
Raw data
{
"_id": null,
"home_page": null,
"name": "stencila_plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "programmable reproducible interactive documents python SDK",
"author": null,
"author_email": "Nokome Bentley <nokome@stencila.io>, Brett Calcott <brett@dragonfly.co.nz>",
"download_url": "https://files.pythonhosted.org/packages/1e/7b/8d73987ba39c0e5db335b6fad1bc4a931e5eb6f03a264d45437532fe0e2b/stencila_plugin-2.0.0a29.tar.gz",
"platform": null,
"description": "# Stencila Plugin\n\n[![stencila_plugin](https://img.shields.io/pypi/v/stencila_plugin.svg?logo=python&label=stencila_plugin&style=for-the-badge&color=1d3bd1&logoColor=66ff66&labelColor=3219a8)](https://pypi.org/project/stencila_plugin/)\n\n## Introduction\n\nThis package provides tools for writing a [Stencila](https://github.com/stencila/stencila) plugin.\nStencila plugins extend the functionality of Stencila, and are dynamically loaded at runtime.\nThey communicate with the core Stencila app via JSON-RPC over a port, or via stdin/stdout.\nThis package implements much of the core functionality for communication, and makes writing a plugin as simple as filling out a few python functions.\n\n## \u26a1 Usage\n\nThe plugin can be installed via `pip`.\n\n`pip install stencila_plugin`\n\nAn example of how to write a plugin can be seen in this [repo](https://github.com/stencila/plugin-example-python).\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Library for building Stencila Plugins",
"version": "2.0.0a29",
"project_urls": {
"Homepage": "https://github.com/stencila/stencila/tree/main/python#readme",
"Repository": "https://github.com/stencila/stencila"
},
"split_keywords": [
"programmable",
"reproducible",
"interactive",
"documents",
"python",
"sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f86ca746e2fa565e1785764325673825d1c1e1173993864743fc95ff5f6af5e2",
"md5": "ae2ec446317ad0f72267af065629cceb",
"sha256": "91ee4f859f326e9f8d13ac6f54c51a7091a443e0e6d5bddbef85da63a447f3ab"
},
"downloads": -1,
"filename": "stencila_plugin-2.0.0a29-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae2ec446317ad0f72267af065629cceb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9671,
"upload_time": "2024-03-26T03:59:37",
"upload_time_iso_8601": "2024-03-26T03:59:37.826423Z",
"url": "https://files.pythonhosted.org/packages/f8/6c/a746e2fa565e1785764325673825d1c1e1173993864743fc95ff5f6af5e2/stencila_plugin-2.0.0a29-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e7b8d73987ba39c0e5db335b6fad1bc4a931e5eb6f03a264d45437532fe0e2b",
"md5": "42478400924014bc84ca8bf5ad6351a3",
"sha256": "dd22ea02eb00611445e42fa135f37726e569e8cec0d4c52ea8bc7169e9b477e2"
},
"downloads": -1,
"filename": "stencila_plugin-2.0.0a29.tar.gz",
"has_sig": false,
"md5_digest": "42478400924014bc84ca8bf5ad6351a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10152,
"upload_time": "2024-03-26T03:59:39",
"upload_time_iso_8601": "2024-03-26T03:59:39.570900Z",
"url": "https://files.pythonhosted.org/packages/1e/7b/8d73987ba39c0e5db335b6fad1bc4a931e5eb6f03a264d45437532fe0e2b/stencila_plugin-2.0.0a29.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 03:59:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "stencila",
"github_project": "stencila",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "stencila_plugin"
}