# OpenPlugin
[](https://pypi.org/project/openplugin-py/)
[](https://hitsofcode.com/github/OpenRL-Lab/OpenPlugin/view?branch=main)
[](https://openplugin.readthedocs.io/en/latest/?badge=latest)
[[demo video](https://youtu.be/QByu8i9zO04)] | [[bilibili video](https://www.bilibili.com/video/BV1AM4y1s7Qu)]
OpenPlugin-v0.0.8 is updated on Aug 17, 2023
Toolkit for managing plugins of Large Language Model (LLM). You can install, uninstall, run and list plugins with `op`.
## Installation
- `pip install openplugin-py` (or clone this repo and `pip install -e .`).
## Plugin Store
We provide plugins in [Plugin Store](https://openrl.net/plugin-store/). Users can download these plugins and use them with `op`.
## Usage
- Check OpenPlugin's version with: `op --version`
- Check system information: `op --system_info`
- Install a plugin: `op install <plugin_name>`. You can also install local plugins with `op install .`.
- You can also install a plugin from a zip file: `op install <zip_file_path>`.
- Uninstall a plugin: `op uninstall <plugin_name>`
- Start a plugin: `op run <plugin_name>`. You can use `-p` to specify the port of the plugin. By default, the port is 5003. You can also run a local plugin with `op run ./`.
- List installed plugins: `op list`
- Reinstall plugin: `op reinstall <plugin_name>`
## An example for using QRcode_plugin
- Install QRcode_plugin: `op install QRcode_plugin`
- Or You can install QRcode_plugin from local:
- Go to the directory of QRcode_plugin: `cd plugins/QRcode_plugin`
- Install QRcode_plugin: `op install .`
- Or you can install QRcode_plugin from a zip file: `op install QRcode_plugin.zip`
- Start QRcode_plugin: `op run QRcode_plugin -p server_port`
- Or you can start QRcode_plugin from local:
- Go to the directory of QRcode_plugin: `cd plugins/QRcode_plugin`
- Start QRcode_plugin: `op run ./ -p server_port`
- Then you can get the `ai-plugin.json` file via visiting `http://<server_ip>:server_port/ai-plugin.json`
- You can get the `openaip.yaml` file via visiting `http://<server_ip>:server_port/openaip.yaml`
## Plugins
We provide some source codes of plugins. You can find them in [plugins](./plugins).
We call for contributions of plugins.
You can fork our repo, add your plugin into [plugins](./plugins) and submit a Pull Request.
## Citing OpenPlugin
If our work has been helpful to you, please feel free to cite us:
```latex
@misc{openplugin2023,
title={OpenPlugin},
author={OpenRL Contributors},
publisher = {GitHub},
howpublished = {\url{https://github.com/OpenRL-Lab/OpenPlugin}},
year={2023},
}
```
## Star History
[](https://star-history.com/#OpenRL-Lab/OpenPlugin&Date)
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenRL-Lab/openplugin",
"name": "openplugin-py",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "LLM plugin toolkit",
"author": "openrl contributors",
"author_email": "huangsy1314@163.com",
"download_url": "https://files.pythonhosted.org/packages/58/02/c5cfa624625392876ebebec049f273851d680ce8dda396d928be5e759761/openplugin-py-0.0.8.tar.gz",
"platform": null,
"description": "# OpenPlugin\n\n[](https://pypi.org/project/openplugin-py/)\n\n[](https://hitsofcode.com/github/OpenRL-Lab/OpenPlugin/view?branch=main)\n\n[](https://openplugin.readthedocs.io/en/latest/?badge=latest)\n\n[[demo video](https://youtu.be/QByu8i9zO04)] | [[bilibili video](https://www.bilibili.com/video/BV1AM4y1s7Qu)]\n\nOpenPlugin-v0.0.8 is updated on Aug 17, 2023\n\nToolkit for managing plugins of Large Language Model (LLM). You can install, uninstall, run and list plugins with `op`.\n\n## Installation\n\n- `pip install openplugin-py` (or clone this repo and `pip install -e .`).\n\n\n## Plugin Store\n\nWe provide plugins in [Plugin Store](https://openrl.net/plugin-store/). Users can download these plugins and use them with `op`.\n\n## Usage\n\n- Check OpenPlugin's version with: `op --version`\n- Check system information: `op --system_info`\n- Install a plugin: `op install <plugin_name>`. You can also install local plugins with `op install .`.\n - You can also install a plugin from a zip file: `op install <zip_file_path>`.\n- Uninstall a plugin: `op uninstall <plugin_name>`\n- Start a plugin: `op run <plugin_name>`. You can use `-p` to specify the port of the plugin. By default, the port is 5003. You can also run a local plugin with `op run ./`.\n- List installed plugins: `op list`\n- Reinstall plugin: `op reinstall <plugin_name>`\n\n## An example for using QRcode_plugin\n\n- Install QRcode_plugin: `op install QRcode_plugin`\n- Or You can install QRcode_plugin from local:\n - Go to the directory of QRcode_plugin: `cd plugins/QRcode_plugin`\n - Install QRcode_plugin: `op install .`\n- Or you can install QRcode_plugin from a zip file: `op install QRcode_plugin.zip`\n- Start QRcode_plugin: `op run QRcode_plugin -p server_port`\n- Or you can start QRcode_plugin from local:\n - Go to the directory of QRcode_plugin: `cd plugins/QRcode_plugin`\n - Start QRcode_plugin: `op run ./ -p server_port`\n- Then you can get the `ai-plugin.json` file via visiting `http://<server_ip>:server_port/ai-plugin.json`\n- You can get the `openaip.yaml` file via visiting `http://<server_ip>:server_port/openaip.yaml`\n\n## Plugins\n\nWe provide some source codes of plugins. You can find them in [plugins](./plugins). \nWe call for contributions of plugins. \nYou can fork our repo, add your plugin into [plugins](./plugins) and submit a Pull Request.\n\n\n## Citing OpenPlugin\n\nIf our work has been helpful to you, please feel free to cite us:\n```latex\n@misc{openplugin2023,\n title={OpenPlugin},\n author={OpenRL Contributors},\n publisher = {GitHub},\n howpublished = {\\url{https://github.com/OpenRL-Lab/OpenPlugin}},\n year={2023},\n}\n```\n\n## Star History\n\n[](https://star-history.com/#OpenRL-Lab/OpenPlugin&Date)\n",
"bugtrack_url": null,
"license": "",
"summary": "Toolkit and Collection for Plugins of Large Language Models",
"version": "0.0.8",
"project_urls": {
"Code": "https://github.com/OpenRL-Lab/openplugin",
"Documentation": "https://openplugin.readthedocs.io/",
"Homepage": "https://github.com/OpenRL-Lab/openplugin"
},
"split_keywords": [
"llm",
"plugin",
"toolkit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5047db59862eaf1d46b7d377816ba621092414b50fcbddc9b96120548e5b9e9",
"md5": "83b5b886f606b26b1b68e6157e4502dc",
"sha256": "9621651cefc507a3020304a702d9674b357e92313c7d906ecb0a2d6137d36323"
},
"downloads": -1,
"filename": "openplugin_py-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "83b5b886f606b26b1b68e6157e4502dc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 34829,
"upload_time": "2023-08-24T03:14:31",
"upload_time_iso_8601": "2023-08-24T03:14:31.483269Z",
"url": "https://files.pythonhosted.org/packages/e5/04/7db59862eaf1d46b7d377816ba621092414b50fcbddc9b96120548e5b9e9/openplugin_py-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5802c5cfa624625392876ebebec049f273851d680ce8dda396d928be5e759761",
"md5": "85015183a6acd53b9d0d461f68f5f169",
"sha256": "027f524e40424e91849bde509041d8c6ed01e585d7dff9ac62aa5fedc6f02d7e"
},
"downloads": -1,
"filename": "openplugin-py-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "85015183a6acd53b9d0d461f68f5f169",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21453,
"upload_time": "2023-08-24T03:14:36",
"upload_time_iso_8601": "2023-08-24T03:14:36.238404Z",
"url": "https://files.pythonhosted.org/packages/58/02/c5cfa624625392876ebebec049f273851d680ce8dda396d928be5e759761/openplugin-py-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-24 03:14:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenRL-Lab",
"github_project": "openplugin",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "openplugin-py"
}
JSON
