https://github.com/jrodal98/nma
Sends a desktop notification after a process completes
https://github.com/jrodal98/nma
decorator desktop-notification python
Last synced: about 1 year ago
JSON representation
Sends a desktop notification after a process completes
- Host: GitHub
- URL: https://github.com/jrodal98/nma
- Owner: jrodal98
- Created: 2020-03-01T04:57:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-29T17:38:55.000Z (almost 6 years ago)
- Last Synced: 2025-06-18T19:46:53.442Z (about 1 year ago)
- Topics: decorator, desktop-notification, python
- Language: Python
- Size: 90.8 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **N**otify **M**e **A**fter
## About
**N**otify **M**e **A**fter (nma) is a python package that sends a desktop notification whenever a shell process or decorated function finishes execution. This repository provides a python shell script for general use and a decorator for use within python code.
## Requirements:
- Linux or MacOS
- If running Linux, `send-notify` also needs to be installed
- Google it for your distro. It's probably already installed, unless you're running something like arch with no desktop enviroment.
- If running MacOS, `terminal-notifier` also needs to be installed
- `brew install terminal-notifier`
- python 3.6+
## Installation
`pip install nma`
or
`pip3 install nma`
or
`python3 -m pip install nma`
or
`pip install --user nma`
or some combination of these strategies.
## Examples
### In shell scripts
`nma "echo test"`
`nma "sudo pacman -Syu"`
`nma "sleep 1; echo test"`
`sleep 1; echo test | nma -`
```bash
my_func() {
sleep .1;
}
my_func | nma -
```
### Decorator
```python
from nma.notify_decorator import notify_after
@notify_after
def test():
print("basic test")
```
## Unimplemented Features
* ~~Call script via piping (ex: `sleep 1 | nma -`)~~
* Email notifications
* Text notifications