github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

dev documentation reflects environment setup

pull/288/head
Chris Caron 2020-09-01 22:46:31 -04:00
parent 397ad4de0f
commit f7cbbcf310
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
bin/README.md
View File

@ -1,6 +1,13 @@
# Apprise Development Tools
This directory just contains some tools that are useful when developing with Apprise. The tools are as follows:
This directory just contains some tools that are useful when developing with Apprise. It is presumed that you've set yourself up with a working development environment before using the tools identified here:
```bash
# Using pip, setup a working development environment:
pip install -r dev-requirements.txt
```
The tools are as follows:
- :gear: `apprise`: This effectively acts as the `apprise` tool would once Apprise has been installed into your environment. However `apprise` uses the branch you're working in. So if you added a new Notification service, you can test with it as you would easily. `apprise` takes all the same parameters as the `apprise` tool does.