https://github.com/guard/notiffany
wrapper for popular notification libs
https://github.com/guard/notiffany
Keywords from Contributors
activerecord activejob mvc rspec rubygems rack nokogiri grape sinatra ruby-gem
Last synced: 13 minutes ago
JSON representation
Repository metadata
wrapper for popular notification libs
- Host: GitHub
- URL: https://github.com/guard/notiffany
- Owner: guard
- License: mit
- Created: 2014-12-27T18:25:39.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-11-03T13:43:59.000Z (about 3 years ago)
- Last Synced: 2025-11-29T06:15:59.447Z (14 days ago)
- Language: Ruby
- Size: 371 KB
- Stars: 34
- Watchers: 4
- Forks: 26
- Open Issues: 21
- Releases: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
README.md
Notiffany
Notification library supporting popular notifiers, such as:
- Growl
- libnotify
- TMux
- Emacs (see: https://github.com/guard/notiffany/wiki/Emacs-support)
- rb-notifu
- notifysend
- gntp
- TerminalNotifier
Features
- most popular notification libraries supported
- easy to override options at any level (new(), notify())
- using multiple notifiers simultaneously
- child processes reuse same configuration
Installation
Add this line to your application's Gemfile:
gem 'notiffany'
And then execute:
$ bundle
Or install it yourself as:
$ gem install notiffany
Usage
Basic notification
notifier = Notiffany.connect(title: "A message")
notifier.notify("Hello there!", image: :success)
notifier.disconnect # some plugins like TMux and TerminalTitle rely on this
Enabling/disabling and on/off
disable with option
notifier = Notiffany.connect(notify: false)
notifier.notify('hello') # does nothing
switch on/off using methods
notifier = Notiffany.connect
notifier.turn_off
notifier.turn_on
notifier.toggle
Customizing options
Options vary on the notifier type. The full list is here: https://github.com/guard/notiffany/tree/master/lib/notiffany/notifier
Currently, only TMux has "dynamic options". (Open an issue if you need this for other plugins).
"Dynamic options" means that you can have custom options (and custom defaults) for custom notifications.
Currently, the main notification types are: success, pending, failed and notify
For example, the default message format for TMux is: default_message_format: "%s - %s"
If you send a notification success, it will look for success_message_format and if that setting isn't available, it will fall back to default_message_format.
This means you can set colors for any notification type, e.g. you can set foo_message_color, for notifications of type foo.
Ideally in the future this would allow you to send custom notifications with custom icons, e.g. foo_icon which has a default value of default_icon for plugins that show icons, etc.
Contributing
- Fork it ( https://github.com/[my-github-username]/notiffany/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Owner metadata
- Name: Guard
- Login: guard
- Email:
- Kind: organization
- Description:
- Website: http://guardgem.org
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/351846?v=4
- Repositories: 108
- Last ynced at: 2023-04-09T03:40:22.349Z
- Profile URL: https://github.com/guard
GitHub Events
Total
- Fork event: 1
Last Year
Committers metadata
Last synced: 8 days ago
Total Commits: 160
Total Committers: 38
Avg Commits per committer: 4.211
Development Distribution Score (DDS): 0.763
Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0
| Name | Commits | |
|---|---|---|
| Cezary Baginski | c****y@c****t | 38 |
| Michael Kessler | m****i@n****h | 31 |
| Rémy Coutable | r****y@r****e | 19 |
| Thibaud Guillaume-Gentil | t****d@t****e | 10 |
| Wouter de Vos | w****r@s****m | 5 |
| Rémy Coutable | r****i@r****e | 4 |
| Roy van de Water | d****y@i****m | 4 |
| Amiel Martin | a****n@g****m | 4 |
| John Bintz | j****n@c****m | 4 |
| Yann Lugrin | y****n@l****h | 4 |
| Eito Katagiri | e****l@g****m | 3 |
| Matthijs Groen | m****n@g****m | 3 |
| slavic | s****r@g****m | 3 |
| Tomas Pokorny | t****t@n****z | 2 |
| Dave Strock | d****k@g****m | 2 |
| Scott Parrish | a****i@g****m | 2 |
| Adam Spiers | g****d@a****g | 1 |
| Marian Schubert | m****o@n****z | 1 |
| Alan Dipert | a****n@d****g | 1 |
| ka | k****f@g****m | 1 |
| cablegram | c****m@g****m | 1 |
| Wade Tandy | w****e@w****m | 1 |
| Scott Davis | j****1@g****m | 1 |
| Rudi Luzar | r****i@r****m | 1 |
| Petr Skocik | p****k@g****m | 1 |
| Nick Sieger | n****k@n****m | 1 |
| Nick Mabry | n****y@g****m | 1 |
| Michael Branch | m****h@w****m | 1 |
| Matt Green | m****s@g****m | 1 |
| Maher Sallam | m****r@s****e | 1 |
| and 8 more... | ||
Committer domains:
- rymai.me: 2
- netsafe.cz: 2
- chronomantic.net: 1
- netzpiraten.ch: 1
- thibaud.me: 1
- surecreations.com: 1
- integrumtech.com: 1
- coswellproductions.com: 1
- liquid-concept.ch: 1
- adamspiers.org: 1
- dipert.org: 1
- wadetandy.com: 1
- rudicode.com: 1
- nicksieger.com: 1
- warbyparker.com: 1
- sallam.me: 1
- vanderbilt.edu: 1
Issue and Pull Request metadata
Last synced: 8 days ago
Total issues: 20
Total pull requests: 25
Average time to close issues: 11 months
Average time to close pull requests: 8 months
Total issue authors: 14
Total pull request authors: 18
Average comments per issue: 1.75
Average comments per pull request: 1.68
Merged pull request: 14
Bot issues: 0
Bot pull requests: 0
Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- e2 (5)
- cout (2)
- docwhat (2)
- hovsater (1)
- ronyv89 (1)
- zx1986 (1)
- michaelherold (1)
- twentyonetwice (1)
- felixonmars (1)
- mikelococo (1)
- r4v5 (1)
- cmer (1)
- eitoball (1)
- danielma (1)
Top Pull Request Authors
- e2 (5)
- eitoball (3)
- jackorp (2)
- leifcr (1)
- JuanitoFatas (1)
- gpakosz (1)
- fearoffish (1)
- nickgrim (1)
- kaosf (1)
- pjump (1)
- olleolleolle (1)
- kaldrenon (1)
- mbranch (1)
- seanhagen (1)
- lucas-nelson (1)
Top Issue Labels
- bug (2)
Top Pull Request Labels
Package metadata
- Total packages: 2
-
Total downloads:
- rubygems: 256,874,357 total
- Total docker downloads: 1,410,894,270
- Total dependent packages: 4 (may contain duplicates)
- Total dependent repositories: 35,404 (may contain duplicates)
- Total versions: 22
- Total maintainers: 2
gem.coop: notiffany
Wrapper libray for most popular notification libraries such as Growl, Libnotify, Notifu
- Homepage: https://github.com/guard/notiffany
- Documentation: http://www.rubydoc.info/gems/notiffany/
- Licenses: MIT
- Latest release: 0.1.3 (published over 6 years ago)
- Last Synced: 2025-12-09T07:56:14.876Z (4 days ago)
- Versions: 11
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 128,474,623 Total
- Docker Downloads: 705,447,135
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 0.078%
- Docker downloads count: 0.131%
- Downloads: 0.182%
- Maintainers (2)
rubygems.org: notiffany
Wrapper libray for most popular notification libraries such as Growl, Libnotify, Notifu
- Homepage: https://github.com/guard/notiffany
- Documentation: http://www.rubydoc.info/gems/notiffany/
- Licenses: MIT
- Latest release: 0.1.3 (published over 6 years ago)
- Last Synced: 2025-12-07T18:03:40.353Z (5 days ago)
- Versions: 11
- Dependent Packages: 4
- Dependent Repositories: 35,404
- Downloads: 128,399,734 Total
- Docker Downloads: 705,447,135
-
Rankings:
- Docker downloads count: 0.164%
- Dependent repos count: 0.173%
- Downloads: 0.197%
- Average: 3.036%
- Dependent packages count: 3.283%
- Forks count: 5.39%
- Stargazers count: 9.011%
- Maintainers (2)
Dependencies
- guard-rspec ~> 4.6 development
- guard-rubocop ~> 1.2 development
- listen ~> 3.1 development
- rspec ~> 3.4 development
- rubocop ~> 0.40 development
- nenv ~> 0.3
- rake ~> 11.1
- bundler ~> 1.7 development
- nenv ~> 0.1
- shellany ~> 0.0
Score: 28.879693749412084