-
Notifications
You must be signed in to change notification settings - Fork 136
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
github: Issue template for new plugin
Signed-off-by: John Andersen <john.s.andersen@intel.com>
- Loading branch information
Showing
1 changed file
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
name: New Plugin | ||
about: I've created a new plugin for DFFML | ||
title: 'plugin: new: ' | ||
labels: documentation | ||
assignees: '' | ||
|
||
--- | ||
|
||
I've created a new plugin for DFFML! | ||
|
||
The package name on PyPi is .... / GitHub repo is .... | ||
|
||
It provides Sources / Models / Operations / Data Flow | ||
|
||
The following are it's `entry_points` | ||
|
||
```python | ||
# (copy paste yours here, example is from dffml/setup.py) | ||
entry_points={ | ||
'dffml.source': [ | ||
'csv = dffml.source.csv:CSVSource', | ||
'json = dffml.source.json:JSONSource', | ||
'memory = dffml.source.memory:MemorySource', | ||
], | ||
} | ||
``` | ||
|
||
Here is what each one does (in rST, leave the \`\`\` so it can be copy pasted) | ||
|
||
`*Community*` means that you are a member of the DFFML community that is | ||
contributing a plugin. If there is a plugin maintained within the DFFML git repo | ||
that needs to be added to the documentation it will be `*Core*`. | ||
|
||
``` | ||
CSV | ||
--- | ||
*Community* | ||
Loads and saves Repos from CSV files. | ||
**Args** | ||
- filename: String | ||
- Path to CSV file | ||
- readonly: Boolean | ||
- True if the file should not be written back to | ||
``` |