Metadata-Version: 2.1
Name: OpenNTFY
Version: 0.1.2
Summary: A simple command line tool to send notifications to your telegram bot
Home-page: https://github.com/FlavioRenzi/OpenNTFY
Author: Flavio Renzi
Author-email: flavioinv@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: altgraph ==0.17.4
Requires-Dist: anyio ==4.0.0
Requires-Dist: certifi ==2023.7.22
Requires-Dist: charset-normalizer ==3.3.2
Requires-Dist: docutils ==0.21.2
Requires-Dist: exceptiongroup ==1.1.3
Requires-Dist: h11 ==0.14.0
Requires-Dist: httpcore ==1.0.2
Requires-Dist: httpx ==0.25.1
Requires-Dist: idna ==3.4
Requires-Dist: importlib-metadata ==6.8.0
Requires-Dist: jaraco.classes ==3.4.0
Requires-Dist: jaraco.context ==5.3.0
Requires-Dist: jaraco.functools ==4.0.1
Requires-Dist: keyring ==25.2.1
Requires-Dist: linkify-it-py ==2.0.2
Requires-Dist: markdown-it-py ==3.0.0
Requires-Dist: mdit-py-plugins ==0.4.0
Requires-Dist: mdurl ==0.1.2
Requires-Dist: more-itertools ==10.3.0
Requires-Dist: nh3 ==0.2.17
Requires-Dist: packaging ==24.1
Requires-Dist: pefile ==2023.2.7
Requires-Dist: pkginfo ==1.11.1
Requires-Dist: Pygments ==2.16.1
Requires-Dist: pyte ==0.8.2
Requires-Dist: python-telegram-bot ==20.6
Requires-Dist: pywin32-ctypes ==0.2.2
Requires-Dist: readme-renderer ==43.0
Requires-Dist: requests ==2.32.3
Requires-Dist: requests-toolbelt ==1.0.0
Requires-Dist: rfc3986 ==2.0.0
Requires-Dist: rich ==13.6.0
Requires-Dist: setuptools ==70.0.0
Requires-Dist: sniffio ==1.3.0
Requires-Dist: textual ==0.41.0
Requires-Dist: twine ==5.1.0
Requires-Dist: typing-extensions ==4.8.0
Requires-Dist: uc-micro-py ==1.0.2
Requires-Dist: urllib3 ==2.2.2
Requires-Dist: wcwidth ==0.2.9
Requires-Dist: wheel ==0.43.0
Requires-Dist: zipp ==3.17.0

# OpenNTFY

A simple command line tool to send notifications to your telegram bot

## Installation

OpenNTFY is installed as a python module using pip

```bash
pip install OpenNTFY
```

the first time run the following command to configure OpenNTFY

```bash
OpenNTFY --config
```

This will store your telegram bot token and chat id in the config file in:

```
linux
~/.config/OpenNTFY/config.json
```

```
windows
C:\Users\{username}\AppData\Roaming\OpenNTFY\config.json
```

## Example usage

Send a message to your telegram bot

```bash
OpenNTFY "Test message"
```

Send a message to your telegram bot after the execution of a command

```bash
sudo apt upgrade; OpenNTFY "Upgrade terminated on {N}"
```

Send a message to your telegram bot after the execution of a command with the result of the command

```bash
long_program | OpenNTFY "Program terminated with result:"
```

Send a message to your telegram bot after the execution of a command and also a periodic message with the live view of it
> :warning: this is not supported on 


```bash
OpenNTFY -p 5m30s "watch ip address" "End message"
```

Send a file to your telegram bot

```bash
OpenNTFY -f /path/to/file "Message with file"
```

## Supported placeholders

You can use the following placeholders in your messages:

- `{N}` - Name of the computer running the command
- `{T}` - Time of the command execution
- `{D}` - Date of the command execution

## ToDo

- [x] Add config file
- [x] Add install script
- [x] Implement periodic notifications
- [x] Add initial guided setup
- [x] Add support for file sending
- [x] Add verbose mode
- [x] Add installation guide
- [ ] Fix periodic send support for windows
