https://github.com/eliostvs/tomate-plugin-template
A Copier template for Tomate plugin
https://github.com/eliostvs/tomate-plugin-template
copier-template
Last synced: 9 days ago
JSON representation
A Copier template for Tomate plugin
- Host: GitHub
- URL: https://github.com/eliostvs/tomate-plugin-template
- Owner: eliostvs
- License: other
- Created: 2021-05-12T02:03:52.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-04T08:12:05.000Z (over 3 years ago)
- Last Synced: 2025-01-24T12:13:59.359Z (12 months ago)
- Topics: copier-template
- Language: Jinja
- Homepage:
- Size: 95.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md.jinja
- Changelog: CHANGELOG.md
- License: LICENSE.jinja
- Authors: AUTHORS.jinja
Awesome Lists containing this project
README
# Tomate {{ plugin_name }} Plugin
{{ plugin_description }}
## Installation
## Usage
## Development
Install the following native dependencies in you system:
- Python3
- pip
- make
- git
- git-flow
- tomate/tomate-gtk
Install the Python development dependencies:
```bash
pip install --user black bumpversion copier pytest pytest-cov pytest-flake8 pytest-mock pre-commit
```
Create the plugin project:
```bash
copier gh:eliostvs/tomate-plugin-template path/to/plugin/project`
```
### Media Files
If this plugin uses media files (icons, mp3, etc), copy them to the **data** directory in root of the repository.
### Testing
Personalize the .pre-commit-config.yaml
Format the files using [black](https://pypi.org/project/black/):
```bash
make format
```
Run test in your local environment:
```bash
make test
```
Run test inside the docker:
```bash
make docker-test
```
Test manually the plugin:
```bash
ln -s ~/.local/share/tomate/plugins path/to/plugin/project/data/plugins
tomate-gtk -v
```
Then activate the plugin through the settings.
### Release
Update the *[Unrelease]* section in the CHANGELOG.md file then:
`make release-[patch|minor|major]`