Eclectic Media Git toast-with_toast_when_complete / 513c72e
Added a usage section to the README Ariana Giroux 8 months ago
1 changed file(s) with 19 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
1515
1616 *Note: You may need to install the BurntToast_ powershell executable. To do so, run "Install-Module -Name BurntToast" (with administrator privilleges)*
1717
18 Usage
19 =====
20
21 First and foremost, the package provides a simple python API for notification scripting: ::
22
23 >>> from toast import toast
24 >>> toast(body='my message body',
25 >>> title='my optional title') # notification spawns
26
27 It also provides a simple `Click CLI` based command line interface. It can be used by simply using: ::
28
29 $ toast 'my message body' -t 'my optional title' # notification spawns
30
31
32 A Note about Compatibility
33 ==========================
34
35 It should be noted that this package is initially developed for the Windows Subsystem Layer for Linux, and may have mixed results on native Windows python interpreters. By design, the package only requires that BurntToast_ be on the system path, and callable from the command line with ``$ burnttoast.exe``. Feel free to submit a bug report to ``ariana.giroux+toast@gmail.com`` if you encounter issues. While untested under Windows proper, it should run without issue.
1836
1937 Contributing to the Project
2038 ===========================
3654
3755
3856 .. _BurntToast: https://github.com/Windos/BurntToast
57 .. _repository: https://git.eclecticmedia.space/public/toast