├── .github └── workflows │ └── push.yml ├── .gitignore ├── README.md ├── cookiecutter.json ├── input-for-demo.txt ├── llm-{{cookiecutter.hyphenated}} ├── .github │ └── workflows │ │ ├── publish.yml │ │ └── test.yml ├── .gitignore ├── LICENSE ├── README.md ├── llm_{{cookiecutter.underscored}}.py ├── pyproject.toml └── tests │ └── test_{{cookiecutter.underscored}}.py ├── requirements.txt └── tests └── test_cookiecutter_template.py /.github/workflows/push.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | 8 | jobs: 9 | test_template: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v4 13 | with: 14 | path: main 15 | - name: Set up Python 16 | uses: actions/setup-python@v5 17 | with: 18 | python-version: "3.12" 19 | cache: pip 20 | - name: Install dependencies 21 | run: | 22 | pip install -r main/requirements.txt 23 | - name: Run tests 24 | run: python -m pytest main/tests 25 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .venv 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | venv 6 | .eggs 7 | .pytest_cache 8 | *.egg-info 9 | .DS_Store 10 | .idea/ 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # llm-plugin cookiecutter template 2 | 3 | A cookiecutter template for creating new [llm plugins](https://llm.datasette.io/en/stable/plugins/index.html). 4 | ` 5 | ## Installation 6 | 7 | You'll need to have [cookiecutter](https://cookiecutter.readthedocs.io/) installed. I recommend pipx for this: 8 | 9 | pipx install cookiecutter 10 | 11 | Regular `pip` will work OK too. 12 | 13 | ## Usage 14 | 15 | Run `cookiecutter gh:simonw/llm-plugin` and then answer the prompts. Here's an example run: 16 | 17 | ```bash 18 | cookiecutter gh:simonw/llm-plugin 19 | ``` 20 | ``` 21 | plugin_name []: plugin template demo 22 | description []: Demonstrating https://github.com/simonw/llm-plugin 23 | hyphenated [plugin-template-demo]: 24 | underscored [plugin_template_demo]: 25 | github_username []: simonw 26 | author_name []: Simon Willison 27 | ``` 28 | I strongly recommend accepting the suggested value for "hyphenated" and "underscored" by hitting enter on those prompts. 29 | 30 | This will create a directory called `llm-plugin-template-demo` - the plugin name you enter is converted to lowercase and uses hyphens instead of spaces. 31 | 32 | ## Developing your plugin 33 | 34 | Having created the new plugin structure from the template, here's how to start working on the plugin. 35 | 36 | You can install the plugin in "editable" mode like so: 37 | 38 | ```bash 39 | llm install -e . 40 | ``` 41 | Run this in the `llm-plugin-template-demo` directory. 42 | 43 | You can also pass the path to that directory like this: 44 | 45 | ```bash 46 | llm install -e path/to/llm-plugin-template-demo 47 | ``` 48 | 49 | To confirm it is installed, run: 50 | 51 | ```bash 52 | llm plugins 53 | ``` 54 | 55 | You should see the following: 56 | ```json 57 | [ 58 | { 59 | "name": "llm-plugin-template-demo", 60 | "hooks": [ 61 | "prepare_connection", 62 | "register_commands" 63 | ], 64 | "version": "0.1" 65 | } 66 | ] 67 | ``` 68 | You can run the tests for your plugin with `python -m pytest` - follow the development environment instructions in the plugin's generated README for details. 69 | -------------------------------------------------------------------------------- /cookiecutter.json: -------------------------------------------------------------------------------- 1 | { 2 | "plugin_name": "", 3 | "description": "", 4 | "hyphenated": "{{ '-'.join(cookiecutter['plugin_name'].lower().split()).replace('_', '-') }}", 5 | "underscored": "{{ cookiecutter.hyphenated.replace('-', '_') }}", 6 | "github_username": "", 7 | "author_name": "" 8 | } 9 | -------------------------------------------------------------------------------- /input-for-demo.txt: -------------------------------------------------------------------------------- 1 | plugin template demo 2 | Demonstrating https://github.com/simonw/llm-plugin 3 | 4 | 5 | simonw 6 | Simon Willison -------------------------------------------------------------------------------- /llm-{{cookiecutter.hyphenated}}/.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish Python Package 2 | {% raw %} 3 | on: 4 | release: 5 | types: [created] 6 | 7 | permissions: 8 | contents: read 9 | 10 | jobs: 11 | test: 12 | runs-on: ubuntu-latest 13 | strategy: 14 | matrix: 15 | python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] 16 | steps: 17 | - uses: actions/checkout@v4 18 | - name: Set up Python ${{ matrix.python-version }} 19 | uses: actions/setup-python@v5 20 | with: 21 | python-version: ${{ matrix.python-version }} 22 | cache: pip 23 | cache-dependency-path: pyproject.toml 24 | - name: Install dependencies 25 | run: | 26 | pip install -e '.[test]' 27 | - name: Run tests 28 | run: | 29 | python -m pytest 30 | deploy: 31 | runs-on: ubuntu-latest 32 | needs: [test] 33 | environment: release 34 | permissions: 35 | id-token: write 36 | steps: 37 | - uses: actions/checkout@v4 38 | - name: Set up Python 39 | uses: actions/setup-python@v5 40 | with: 41 | python-version: "3.13" 42 | cache: pip 43 | cache-dependency-path: pyproject.toml 44 | - name: Install dependencies 45 | run: | 46 | pip install setuptools wheel build 47 | - name: Build 48 | run: | 49 | python -m build 50 | - name: Publish 51 | uses: pypa/gh-action-pypi-publish@release/v1 52 | {% endraw %} -------------------------------------------------------------------------------- /llm-{{cookiecutter.hyphenated}}/.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: [push, pull_request] 4 | 5 | permissions: 6 | contents: read 7 | {% raw %} 8 | jobs: 9 | test: 10 | runs-on: ubuntu-latest 11 | strategy: 12 | matrix: 13 | python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] 14 | steps: 15 | - uses: actions/checkout@v4 16 | - name: Set up Python ${{ matrix.python-version }} 17 | uses: actions/setup-python@v5 18 | with: 19 | python-version: ${{ matrix.python-version }} 20 | cache: pip 21 | cache-dependency-path: pyproject.toml 22 | - name: Install dependencies 23 | run: | 24 | pip install -e '.[test]' 25 | - name: Run tests 26 | run: | 27 | python -m pytest 28 | {% endraw %} -------------------------------------------------------------------------------- /llm-{{cookiecutter.hyphenated}}/.gitignore: -------------------------------------------------------------------------------- 1 | .venv 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | venv 6 | .eggs 7 | .pytest_cache 8 | *.egg-info 9 | .DS_Store 10 | .vscode 11 | dist 12 | build 13 | -------------------------------------------------------------------------------- /llm-{{cookiecutter.hyphenated}}/LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /llm-{{cookiecutter.hyphenated}}/README.md: -------------------------------------------------------------------------------- 1 | # llm-{{ cookiecutter.hyphenated }} 2 | 3 | [![PyPI](https://img.shields.io/pypi/v/llm-{{ cookiecutter.hyphenated }}.svg)](https://pypi.org/project/llm-{{ cookiecutter.hyphenated }}/){% if cookiecutter.github_username %} 4 | [![Changelog](https://img.shields.io/github/v/release/{{ cookiecutter.github_username }}/llm-{{ cookiecutter.hyphenated }}?include_prereleases&label=changelog)](https://github.com/{{ cookiecutter.github_username }}/llm-{{ cookiecutter.hyphenated }}/releases) 5 | [![Tests](https://github.com/{{ cookiecutter.github_username }}/llm-{{ cookiecutter.hyphenated }}/actions/workflows/test.yml/badge.svg)](https://github.com/{{ cookiecutter.github_username }}/llm-{{ cookiecutter.hyphenated }}/actions/workflows/test.yml) 6 | [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/{{ cookiecutter.github_username }}/llm-{{ cookiecutter.hyphenated }}/blob/main/LICENSE){% endif %} 7 | 8 | {{ cookiecutter.description or "" }} 9 | 10 | ## Installation 11 | 12 | Install this plugin in the same environment as [LLM](https://llm.datasette.io/). 13 | ```bash 14 | llm install llm-{{ cookiecutter.hyphenated }} 15 | ``` 16 | ## Usage 17 | 18 | Usage instructions go here. 19 | 20 | ## Development 21 | 22 | To set up this plugin locally, first checkout the code. Then create a new virtual environment: 23 | ```bash 24 | cd llm-{{ cookiecutter.hyphenated }} 25 | python -m venv venv 26 | source venv/bin/activate 27 | ``` 28 | Now install the dependencies and test dependencies: 29 | ```bash 30 | python -m pip install -e '.[test]' 31 | ``` 32 | To run the tests: 33 | ```bash 34 | python -m pytest 35 | ``` 36 | -------------------------------------------------------------------------------- /llm-{{cookiecutter.hyphenated}}/llm_{{cookiecutter.underscored}}.py: -------------------------------------------------------------------------------- 1 | import click 2 | import llm 3 | 4 | 5 | @llm.hookimpl 6 | def register_commands(cli): 7 | return 8 | # @cli.command() 9 | # def hello_world(): 10 | # "Say hello world" 11 | # click.echo("Hello world!") 12 | -------------------------------------------------------------------------------- /llm-{{cookiecutter.hyphenated}}/pyproject.toml: -------------------------------------------------------------------------------- 1 | [project] 2 | name = "llm-{{ cookiecutter.hyphenated }}" 3 | version = "0.1" 4 | description = "{{ cookiecutter.description or "" }}" 5 | readme = "README.md" 6 | authors = [{name = "{{ cookiecutter.author_name }}"}] 7 | license = "Apache-2.0" 8 | classifiers = [] 9 | requires-python = ">=3.9" 10 | dependencies = [ 11 | "llm" 12 | ] 13 | 14 | [build-system] 15 | requires = ["setuptools"] 16 | build-backend = "setuptools.build_meta" 17 | {% if cookiecutter.github_username %} 18 | [project.urls] 19 | Homepage = "https://github.com/{{ cookiecutter.github_username }}/llm-{{ cookiecutter.hyphenated }}" 20 | Changelog = "https://github.com/{{ cookiecutter.github_username }}/llm-{{ cookiecutter.hyphenated }}/releases" 21 | Issues = "https://github.com/{{ cookiecutter.github_username }}/llm-{{ cookiecutter.hyphenated }}/issues" 22 | CI = "https://github.com/{{ cookiecutter.github_username }}/llm-{{ cookiecutter.hyphenated }}/actions" 23 | {% endif %} 24 | [project.entry-points.llm] 25 | {{ cookiecutter.underscored }} = "llm_{{ cookiecutter.underscored }}" 26 | 27 | [project.optional-dependencies] 28 | test = ["pytest"] 29 | -------------------------------------------------------------------------------- /llm-{{cookiecutter.hyphenated}}/tests/test_{{cookiecutter.underscored}}.py: -------------------------------------------------------------------------------- 1 | from llm.plugins import pm 2 | 3 | 4 | def test_plugin_is_installed(): 5 | names = [mod.__name__ for mod in pm.get_plugins()] 6 | assert "llm_{{ cookiecutter.underscored }}" in names 7 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | cookiecutter 2 | pytest 3 | -------------------------------------------------------------------------------- /tests/test_cookiecutter_template.py: -------------------------------------------------------------------------------- 1 | from cookiecutter.main import cookiecutter 2 | import pathlib 3 | 4 | TEMPLATE_DIRECTORY = str(pathlib.Path(__file__).parent.parent) 5 | 6 | 7 | def test_generated_files(tmpdir): 8 | generate( 9 | tmpdir, 10 | { 11 | "plugin_name": "foo", 12 | "description": "blah", 13 | }, 14 | ) 15 | assert paths(tmpdir) == { 16 | "llm-foo/.github/workflows", 17 | "llm-foo/LICENSE", 18 | "llm-foo/README.md", 19 | "llm-foo/.github/workflows/publish.yml", 20 | "llm-foo/llm_foo.py", 21 | "llm-foo/.github/workflows/test.yml", 22 | "llm-foo/pyproject.toml", 23 | "llm-foo/.gitignore", 24 | "llm-foo", 25 | "llm-foo/.github", 26 | "llm-foo/tests/test_foo.py", 27 | "llm-foo/tests", 28 | } 29 | 30 | 31 | def generate(directory, context): 32 | cookiecutter( 33 | template=TEMPLATE_DIRECTORY, 34 | output_dir=str(directory), 35 | no_input=True, 36 | extra_context=context, 37 | ) 38 | 39 | 40 | def paths(directory): 41 | paths = list(pathlib.Path(directory).glob("**/*")) 42 | paths = [r.relative_to(directory) for r in paths] 43 | return {str(f) for f in paths if str(f) != "."} 44 | --------------------------------------------------------------------------------