stencila_plugin

Name	stencila_plugin JSON
Version	2.0.0b3 JSON
	download
home_page	None
Summary	Library for building Stencila Plugins
upload_time	2024-08-07 00:33:33
maintainer	None
docs_url	None
author	None
requires_python	>=3.10
license	Apache-2.0
keywords	programmable reproducible interactive documents python sdk
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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 stdin/stdout or HTTP.
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

This package can be installed via `pip`.

`pip install stencila_plugin`

An example of how to write a plugin using this package can be seen in this [repo](https://github.com/stencila/plugin-python-template).


            

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/f7/e0/38122e3dd4f6037c1b1466b0e39cd4c9cd0ac7f8b48fd2eaacd1328c54b4/stencila_plugin-2.0.0b3.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 stdin/stdout or HTTP.\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\nThis package can be installed via `pip`.\n\n`pip install stencila_plugin`\n\nAn example of how to write a plugin using this package can be seen in this [repo](https://github.com/stencila/plugin-python-template).\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Library for building Stencila Plugins",
    "version": "2.0.0b3",
    "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": "2682aaa11cb73562a396db7bbfe863b5e0afbf8d44e4e49aff19a65d0610b752",
                "md5": "ffe05923728b9438a925f80dc168e70d",
                "sha256": "41d8e8e71acc65311c7579a57a782667ca6045d0a0f88573ce3965f6501479b0"
            },
            "downloads": -1,
            "filename": "stencila_plugin-2.0.0b3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ffe05923728b9438a925f80dc168e70d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 10979,
            "upload_time": "2024-08-07T00:33:32",
            "upload_time_iso_8601": "2024-08-07T00:33:32.444200Z",
            "url": "https://files.pythonhosted.org/packages/26/82/aaa11cb73562a396db7bbfe863b5e0afbf8d44e4e49aff19a65d0610b752/stencila_plugin-2.0.0b3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f7e038122e3dd4f6037c1b1466b0e39cd4c9cd0ac7f8b48fd2eaacd1328c54b4",
                "md5": "d12ca610b1f21c1d01e9a1b2587c29ed",
                "sha256": "87c3eef44dd6e2a2248f1ede511e0dfd1e858d361363b9b6bc0f4e68ff6b23f6"
            },
            "downloads": -1,
            "filename": "stencila_plugin-2.0.0b3.tar.gz",
            "has_sig": false,
            "md5_digest": "d12ca610b1f21c1d01e9a1b2587c29ed",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 11021,
            "upload_time": "2024-08-07T00:33:33",
            "upload_time_iso_8601": "2024-08-07T00:33:33.733711Z",
            "url": "https://files.pythonhosted.org/packages/f7/e0/38122e3dd4f6037c1b1466b0e39cd4c9cd0ac7f8b48fd2eaacd1328c54b4/stencila_plugin-2.0.0b3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-07 00:33:33",
    "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"
}