https://github.com/simonw/datasette-plugin-template-repository

GitHub template repository for creating new Datasette plugins, using the simonw/datasette-plugin cookiecutter template
https://github.com/simonw/datasette-plugin-template-repository

Last synced: 26 days ago
JSON representation

GitHub template repository for creating new Datasette plugins, using the simonw/datasette-plugin cookiecutter template

• Host: GitHub
• URL: https://github.com/simonw/datasette-plugin-template-repository
• Owner: simonw
• Created: 2021-08-28T19:50:28.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-12T17:18:45.000Z (6 months ago)
• Last Synced: 2024-10-06T20:54:31.842Z (about 1 month ago)
• Homepage:
• Size: 20.5 KB
• Stars: 24
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Template repository for creating new Datasette plugins

This GitHub [template repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template) can be used to create a new repository with the skeleton of a Datasette plugin, based on the [datasette-plugin](https://github.com/simonw/datasette-plugin) cookiecutter.

Start here: https://github.com/simonw/datasette-plugin-template-repository/generate

Call your new repository `datasette-something` - where the `something' describes your new plugin. You can use additional hyphens - examples of valid plugin repository names include:

- `datasette-places-on-a-map`

- `datasette-emoji`

Add a one-line description of your repository, then click "Create repository from template".

![Screenshot of the create repository form](https://user-images.githubusercontent.com/9599/131229113-76b3d853-44d2-4ea2-8e29-9b09398b885f.png)

Once created, your new repository will execute a GitHub Actions workflow that uses cookiecutter to rewrite the repository to the desired state. This make take 30 seconds or so.

You can see an example of a repository generated using this template here:

- https://github.com/simonw/datasette-plugin-template-repository-demo

## GitHub Actions setup by this repository

The `test.yml` GitHub Actions workflow will run your tests automatically any time you push a change to the repo.

The `publish.yml` Action runs when you create a new GitHub release. It will build and upload your package to [PyPI](https://pypi.org/).

For this to work, you need to create an environment in your GitHub repository called `release`. You then need to configure PyPI with a new "pending publisher" with the following settings:

- PyPI Project Name: `datasette-name-of-your-plugin`

- Owner: Your GitHub username or organization

- Repository name: The name of your repository

- Workflow name: `publish.yml`

- Environment name: `release`

See [Publish releases to PyPI from GitHub Actions without a password or token](https://til.simonwillison.net/pypi/pypi-releases-from-github) for details.