Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sukhbinder/vidtoolz-plugin
Plugin template for vidtoolz
https://github.com/sukhbinder/vidtoolz-plugin
Last synced: about 2 months ago
JSON representation
Plugin template for vidtoolz
- Host: GitHub
- URL: https://github.com/sukhbinder/vidtoolz-plugin
- Owner: sukhbinder
- License: apache-2.0
- Created: 2024-10-29T15:02:54.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-09T08:02:27.000Z (2 months ago)
- Last Synced: 2024-11-09T09:17:18.521Z (2 months ago)
- Language: Python
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vidtoolz-plugin cookiecutter template
A cookiecutter template for creating new [vidtoolz Plugins](https://github.com/sukhbinder/vidtoolz).
## Installation
You'll need to have [cookiecutter](https://cookiecutter.readthedocs.io/) installed. I recommend pipx for this:
```bash
pipx install cookiecutter
```
Regular `pip` will work OK too.
## Usage
Run `cookiecutter gh:sukhbinder/vidtoolz-plugin` and then answer the prompts. Here's an example run:
```bash
cookiecutter gh:sukhbinder/vidtoolz-plugin
```
```
plugin_name []: vidtoolz plugin template demo
description []: Demonstrating https://github.com/sukhbinder/vidtoolz-plugin
hyphenated [vidtoolz-plugin-template-demo]:
underscored [vidtoolz_plugin_template_demo]:
github_username []: sukhbinder
author_name []: Sukhbinder Singh
```
I strongly recommend accepting the suggested value for "hyphenated" and "underscored" by hitting enter on those prompts.
This will create a directory called `vidtoolz-plugin-template-demo` - the plugin name you enter is converted to lowercase and uses hyphens instead of spaces.
## Developing your plugin
Having created the new plugin structure from the template, here's how to start working on the plugin.
You can install the plugin in "editable" mode like so:
```bash
pip install -e .
```
Run this in the `vidtoolz-plugin-template-demo` directory.
You can also pass the path to that directory like this:
```bash
vidtoolz install -e path/to/django-plugin-template-demo
```
## Publishing your plugin to GitHub
Use https://github.com/new to create a new GitHub repository sharing the same name as your plugin, which should be something like `vidtoolz-my-new-plugin`.
Push your `main` branch to GitHub like this:
```bash
git remote add origin [email protected]:YOURNAME/vidtoolz-my-new-plugin.git
git push -u origin main
```
The template will have created a GitHub Action which runs your plugin's test suite against every commit.
## Publishing your plugin as a package to PyPI
The template also includes an Action for publishing packages 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: `vidtoolz-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 Simon's TIL [Publish releases to PyPI from GitHub Actions without a password or token](https://til.simonwillison.net/pypi/pypi-releases-from-github) for details.
With that configured, create a GitHub release with a name that corresponds to the version number listed in your `pyproject.toml` file and the action will build and publish a PyPI package for you.