github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

How to use the datasette-plugin template, refs #687, closes #855

Browse source
This commit is contained in:
Simon Willison 2020-06-21 19:51:26 -07:00
commit 74889aa92e
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/writing_plugins.rst
View file

@ -30,6 +30,19 @@ Now you can navigate to http://localhost:8001/mydb and run this SQL::
To see the output of your plugin. To see the output of your plugin.
Writing an installable plugin
-----------------------------
Plugins that can be installed should be written as Python packages using a ``setup.py`` file.
The easiest way to start writing one an installable plugin is to use the `datasette-plugin <https://github.com/simonw/datasette-plugin>`__ cookiecutter template. This creates a new plugin structure for you complete with an example test and GitHub Actions workflows for testing and publishing your plugin.
`Install cookiecutter <https://cookiecutter.readthedocs.io/en/1.7.2/installation.html>`__ and then run this command to start building a plugin using the template::
cookiecutter gh:simonw/datasette-plugin
Read `a cookiecutter template for writing Datasette plugins <https://simonwillison.net/2020/Jun/20/cookiecutter-plugins/>`__ for more information about this template.
Packaging a plugin Packaging a plugin
------------------ ------------------