Metadata-Version: 2.1
Name: exec-notifier
Version: 0.1.12
Summary: Tool to notify you when command will be executed.
Home-page: https://github.com/tikerlade/exec-notifier
Author: Ivan Kuznetsov
Author-email: tikerlade@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: requests (>=2.25.1,<3.0.0)
Project-URL: Repository, https://github.com/tikerlade/exec-notifier
Description-Content-Type: text/markdown

# Execution Notifier
[![PyPI](https://img.shields.io/pypi/v/exec-notifier)](https://pypi.org/project/exec-notifier/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Actions Status](https://github.com/tikerlade/exec-notifier/workflows/Deploy%20publisher/badge.svg)](https://github.com/tikerlade/exec-notifier/actions/)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/tikerlade/exec-notifier/master.svg)](https://results.pre-commit.ci/latest/github/tikerlade/exec-notifier/master)

This tool provides you ability to send yourself information about looong executed command when it is done. Information will be sent using Telegram Bot, which you can generate for yourself with Telegram BotFather.

## Prerequisites
In execution of your application you will need your Telegram ID. To get it visit [@exec_notifier_bot](https://telegram.me/exec_notifier_bot) and use `/start` command.

## Installation and running
```shell
>>> pip install exec-notifier
>>> exec_notifier config --telegram_id=YOUR_TELEGRAM_ID
>>> exec_notifier notify [your_command_here]
```

## Limitation

If you wnat to run commands with `&&`, `||`, `;`, `|`, `>` in your terminal please use backslash character \ before each of such symbols.

**Example**

```shell
>>> exec_notifier notify ls -l \| head
>>> exec_notifier notify ls -l \> output.txt
>>> exec_notifier notify ls -l \&\& sleep 3
```


## Future :soon:
* Your own bot supportage will be added

