Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goropikari/notifier.jl
Notification tools for Julialang
https://github.com/goropikari/notifier.jl
email-notification julialang notifications
Last synced: 3 months ago
JSON representation
Notification tools for Julialang
- Host: GitHub
- URL: https://github.com/goropikari/notifier.jl
- Owner: goropikari
- License: other
- Archived: true
- Created: 2017-03-06T22:29:58.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-08-16T10:32:06.000Z (over 4 years ago)
- Last Synced: 2024-09-30T15:18:34.593Z (3 months ago)
- Topics: email-notification, julialang, notifications
- Language: Julia
- Homepage:
- Size: 425 KB
- Stars: 14
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Notifier
[](https://travis-ci.org/goropikari/Notifier.jl)
[](https://ci.appveyor.com/project/goropikari/notifier-jl)
[](http://codecov.io/github/goropikari/Notifier.jl?branch=master)
## *This package is no longer maintained.*
This package is notification tools for Julialang.
```julia
using Notifier
notify("Task completed")
```
## Features:
- Linux and macOS
- popup notification (desktop notification)
- sound notification
- say notification (Read a given message aloud)
- email notification
- count up and count down timer
- Windows (Experimental)
- popup notification (desktop notification)
- sound notification
- say notification (Read a given message aloud)
- count up and count down timer
## Installation
```julia
using Pkg
Pkg.add("Notifier")
```
## Setup for Linux user
Before using Notifier.jl, you need to install following softwares in your Linux system.
- `libnotify` for a desktop notification
- `mail` for an e-mail notification
- `aplay` (Advanced Linux Sound Architecture) for a sound notification
- `espeak` for reading a given message aloud
```bash
$ sudo apt install libnotify-bin alsa-utils espeak mailutils heirloom-mailx bsd-mailx
```
This package uses `mail` command to notify by e-mail. You may need some settings in advance.
If following command works correctly, you don't need further setting.
```bash
$ echo test | mail -s foo [email protected]
```
## Usage
### popup notification
```julia
using Notifier
notify("Task completed")
# defalut title is "Julia".
# You can change the title by title option.
notify("Task completed", title="foofoo")
notify("Task completed", sound=true) # with sound
notify("Task completed", sound="foo.wav") # Specify a sound file (for Linux and Windows)
```
Linux
macOS
Windows
### sound and say notification
```julia
alarm() # only sound. You can specify a sound file, alarm(sound="foo.wav")
say("Finish calculation!") # Read aloud
```
### e-mail notification
```julia
email("message", To="[email protected]") # default subject is set by date.
email("message", subject="result", To="[email protected]")
```
If you use `email` function frequently, I recommend you to register your email address by `register_email` function.
```julia
julia> register_email()
Type your desired recipient e-mail address to receive a notification.
e-mail: [email protected]
Recipient e-mail address is saved at /path/to/.julia/v0.6/Notifier/email/address.txt.
If you want to change the address, modify /path/to/.julia/v0.6/Notifier/email/address.txt directly or run register_email() again
```
After you registered, you don't need to specify e-mail address.
```julia
email("message")
```
### Timer
When the specified time limit has been reached, notify by sound.
```julia
h,m,s = 1,2,3
countup(h,m,s) # Hour, Minute, Second
countdown(h,m,s)
```
## Acknowledgement
Inspired by [OSXNotifier.jl](https://github.com/jonasrauber/OSXNotifier.jl).