11## Description:
22** Related issue (if applicable):** #<!-- apprise issue number goes here-->
33
4- <!-- Have anything else to describe? Define it here -->
4+ <!-- Have anything else to describe? Define it here; this helps build the wiki item later
5+ -- Delete this section if you are not creating a new plugin --
6+
7+ ## *ServiceName* Notifications
8+ * **Source**: https://official.website.example.ca
9+ * **Icon Support**: Yes / No
10+ * **Message Format**: Plain Text / HTML / Markdown
11+ * **Message Limit**: nn Characters
12+
13+ Describe your service here..
14+
15+ ### 🛠️ Setup Instructions
16+
17+ 1. Visit [service.site](https://example.ca/) and sign in using your account credentials.
18+ 2. Once logged in, generate and copy your **token** ...
19+
20+ ---
21+
22+ ### ✅ Apprise Support
23+
24+ ### Syntax
25+
26+ Valid syntax is as follows:
27+ - `service://{variable}`
28+
29+ ---
30+
31+ ### 🔐 Parameter Breakdown
32+
33+ | Variable | Required | Description |
34+ |-----------|----------|----------------|
35+ | variable1 | Yes | Your variable1 |
36+ | variable2 | No | Your variable2 |
37+
38+ ---
39+
40+ ### 📦 Examples
41+
42+ Sends a simple example
43+ ```bash
44+ apprise -vv -t "Title" -b "Message content" \
45+ service://token
46+ ```
547
648## New Service Completion Status
749<!-- This section is only applicable if you're adding a new service -->
850* [ ] apprise/plugins/<!-- new plugin name --> .py
9- * [ ] KEYWORDS
51+ * [ ] pypackage.toml update ` keywords ` section to identify our new service
1052 - add new service into this file (alphabetically).
1153* [ ] README.md
1254 - add entry for new service to table (as a quick reference)
1355* [ ] packaging/redhat/python-apprise.spec
1456 - add new service into the ` %global common_description `
1557
58+ -- END OF NEW PLUGIN SECTION - REMOVE ABOVE SECION IF NOT A NEW PLUGIN -->
59+
1660## Checklist
1761<!-- The following must be completed or your PR can't be merged -->
1862* [ ] The code change is tested and works locally.
1963* [ ] There is no commented out code in this PR.
20- * [ ] No lint errors (use ` flake8 ` )
21- * [ ] 100% test coverage
64+ * [ ] No lint errors (use ` tox -e lint ` and even ` tox -e format ` to autofix what it can )
65+ * [ ] Test coverage added (use ` tox -e minimal ` )
2266
2367## Testing
2468<!-- If this your code is testable by other users of the program
25- it would be really helpful to define this here -->
69+ it would be really helpful to define this here -->
2670Anyone can help test this source code as follows:
2771``` bash
2872# Create a virtual environment to work in as follows:
@@ -41,4 +85,8 @@ pip install git+https://github.com/caronc/apprise.git@<this.branch-name>
4185apprise -t " Test Title" -b " Test Message" \
4286 < apprise url related to ticket>
4387
88+ # If you have cloned the branch and have tox available to you
89+ # the following can also allow you to test:
90+ tox -e apprise -- -t " Test Title" -b " Test Message" \
91+ < apprise url related to ticket>
4492```
0 commit comments