Skip to content

Commit 95b9030

Browse files
committed
PICARD-1861: Plugins doc changes after discussion
1 parent 5b2189e commit 95b9030

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

PLUGINS.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,11 @@ The file MUST define the following mandatory metadata fields:
153153

154154
| Field name | Type | Description |
155155
|----------------|--------|------------------------------------------------------------------|
156-
| id | string | The plugin's unique name. Must be a valid Python package name and only consist of the characters `[a-z0-9_]` |
156+
| ~~id~~ | ~~string~~ | ~~The plugin's unique name. Must be a valid Python package name and only consist of the characters `[a-z0-9_]`~~ |
157157
| name | table | Table of multi-lingual display names. The keys are locale names. At least an English description is mandatory. |
158-
| author | string | The plugin author |
158+
| authors | string[] | The plugin author |
159159
| description | table | Table of multi-lingual detailed plugin descriptions. The keys are locale names. At least an English description is mandatory. Supports Markdown formatting. |
160-
| version | string | Plugin version. Use semantic versioning in the format "x.y.z" |
160+
| ~~version~~ | ~~string~~ | ~~Plugin version. Use semantic versioning in the format "x.y.z"~~ |
161161
| api | list | The Picard API versions supported by the plugin |
162162
| license | string | License, should be a [SPDX license name](https://spdx.org/licenses/) and GPLv2 compatible |
163163

@@ -389,6 +389,32 @@ activate the plugin. The UI must make it clear that the user is installing the
389389
plugin at their own risk and that the plugin can execute arbitrary code.
390390

391391

392+
### Blacklisting plugins
393+
TBD
394+
395+
396+
## Plugin management
397+
398+
Picard will provide a command line interface and a options user interface to
399+
manage plugins.
400+
401+
### Command line interface
402+
403+
```
404+
picard plugin list
405+
picard plugin install https://git.sr.ht/~phw/picard-plugin-example
406+
picard plugin info https://git.sr.ht/~phw/picard-plugin-example
407+
picard plugin uninstall ...
408+
picard plugin enable ...
409+
picard plugin disable ...
410+
```
411+
412+
Plugins can be referenced by repository URI or by `{uri-hash}-{last-path-part}`.
413+
E.g. the plugin can be referenced by
414+
`https://git.sr.ht/~phw/picard-plugin-example` or by
415+
`0c43dd9b75eebb260a83e6ac57b4128f-picard-plugin-example`.
416+
417+
392418
## To be discussed
393419

394420
### Localization

0 commit comments

Comments
 (0)