{"id": "writing_plugins:writing-plugins-packaging", "page": "writing_plugins", "ref": "writing-plugins-packaging", "title": "Packaging a plugin", "content": "Plugins can be packaged using Python setuptools. You can see an example of a packaged plugin at  https://github.com/simonw/datasette-plugin-demos \n             The example consists of two files: a  setup.py  file that defines the plugin: \n             from setuptools import setup\n\nVERSION = \"0.1\"\n\nsetup(\n    name=\"datasette-plugin-demos\",\n    description=\"Examples of plugins for Datasette\",\n    author=\"Simon Willison\",\n    url=\"https://github.com/simonw/datasette-plugin-demos\",\n    license=\"Apache License, Version 2.0\",\n    version=VERSION,\n    py_modules=[\"datasette_plugin_demos\"],\n    entry_points={\n        \"datasette\": [\n            \"plugin_demos = datasette_plugin_demos\"\n        ]\n    },\n    install_requires=[\"datasette\"],\n) \n             And a Python module file,  datasette_plugin_demos.py , that implements the plugin: \n             from datasette import hookimpl\nimport random\n\n\n@hookimpl\ndef prepare_jinja2_environment(env):\n    env.filters[\"uppercase\"] = lambda u: u.upper()\n\n\n@hookimpl\ndef prepare_connection(conn):\n    conn.create_function(\n        \"random_integer\", 2, random.randint\n    ) \n             Having built a plugin in this way you can turn it into an installable package using the following command: \n             python3 setup.py sdist \n             This will create a  .tar.gz  file in the  dist/  directory. \n             You can then install your new plugin into a Datasette virtual environment or Docker container using  pip : \n             pip install datasette-plugin-demos-0.1.tar.gz \n             To learn how to upload your plugin to  PyPI  for use by other people, read the PyPA guide to  Packaging and distributing projects .", "breadcrumbs": "[\"Writing plugins\"]", "references": "[{\"href\": \"https://github.com/simonw/datasette-plugin-demos\", \"label\": \"https://github.com/simonw/datasette-plugin-demos\"}, {\"href\": \"https://pypi.org/\", \"label\": \"PyPI\"}, {\"href\": \"https://packaging.python.org/tutorials/distributing-packages/\", \"label\": \"Packaging and distributing projects\"}]"}