Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/abhijithaj/intimations

Generate cross-platform sound intimations, push notifications and get a telegram message when a process execution is finished in the cloud platform.
https://github.com/abhijithaj/intimations

cloud cloud-notifications cloud-to-mobile command-line-tool cool-notifications easy-to-use mobile-notifications notifications process-info-message process-info-mobile-notifications process-info-notification push-notifications python-m python3 sound-notifications system-to-mobile telegram telegram-bot-api telegram-messages toast-notifications

Last synced: 3 months ago
JSON representation

Generate cross-platform sound intimations, push notifications and get a telegram message when a process execution is finished in the cloud platform.

Host: GitHub
URL: https://github.com/abhijithaj/intimations
Owner: AbhijithAJ
Created: 2021-12-22T18:25:21.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2023-02-24T16:12:14.000Z (almost 2 years ago)
Last Synced: 2024-10-31T02:49:35.092Z (3 months ago)
Topics: cloud, cloud-notifications, cloud-to-mobile, command-line-tool, cool-notifications, easy-to-use, mobile-notifications, notifications, process-info-message, process-info-mobile-notifications, process-info-notification, push-notifications, python-m, python3, sound-notifications, system-to-mobile, telegram, telegram-bot-api, telegram-messages, toast-notifications
Language: Python
Homepage:
Size: 1.01 MB
Stars: 15
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

intimations v1.0

[![Generic badge](https://img.shields.io/badge/Made_By-ABHIJITH_BOPPE-BLUE.svg)](https://www.linkedin.com/in/abhijith-boppe/)
[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![Generic badge](https://img.shields.io/badge/pypi_package-1.1-DARKGREEN.svg)](https://pypi.org/project/intimation/) [![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://github.com/AbhijithAJ/intimation/blob/master/LICENSE) [![PayPal](https://img.shields.io/badge/donate-PayPal-blue.svg)](https://www.paypal.me/abhijithboppes)

- Cross platform intimations
- Sound intimations and Toast/Message intimations
- Telegram bot intimations/message
- Flashing Taskbar Icon (for windows platform)
- Supports Command line

---
## ABOUT

This module makes it easy to get intimations such as a beep sound, push/toast notification, or a telegram bot message during and after the execution of code/process

- Simply popup alerts, warnings, success or any other actions with different icons
- Make a buzzer sound with different sound effects
- Receive a message intimations to your smartphone (via telegram bot).

*Using this module, telegram messages would be received when execution of a process/code is completed on system or a cloud platform.*

**Benefits**

You can focus on other activities till you receive an intimation about your executing code/process.

Interactive icons and sounds which will intimate you about the executing process/code's activity will save your time and let you enjoy the status of your executing code/process.

:warning: **Warning:** The intimations module is not secure. Only pass data you trust. :warning:

## Installation

You can install **intimations** by running the following command
```
pip install intimations
```

## Command line Usage

**Get a sound intimation**
```powershell
python -m intimations beep --sound success --count 2 --interval 5
```
*sound : info, danger, success, warning or ANY_MP3_FILE_PATH*

**Get message intimation**
```powershell
python -m intimations push --title 'TITLE OF INTIMATION' --message 'MESSAGE BODY' --icon success
```
*icon : info, danger, success, warning or ANY_ICO_FILE_PATH*

**Get a Telegram bot Message intimation**
```powershell
python -m intimations telegram --botapi YOUR_TELEGRAM_BOT_API --chatid YOUR_BOT_CHAT_ID --title 'TITLE OF INTIMATION' --message 'MESSAGE BODY'
```

*Follow the video to create telegram botAPI and get chatID*

https://user-images.githubusercontent.com/47808835/146597010-a5e877c2-affa-45c7-a4ae-947839808043.mp4

```
To get chat id, navigate to 'https://api.telegram.org/bot/getUpdates' in your browser.

Replace '' with your bot api token.
```

## Using Telegram message feature effectively

Create Telegram bot and get the botAPI token and chatID as shown in the video.

Create **BOTAPI** and **CHATID** in your OS environmental variables and assign there values.

Now, on terminal, type your command and then enter python module command, as shown below.

```bash
ffuf -w 'wordlist.txt' -u 'https://target/FUZZ' ; python3 -m intimations telegram -t "Title of Process" -m "Successfully executed"
```
You will receive a Telegram notification on your mobile device once your cloud platform has completed FUZZING or the execution of your command.

### Integrating intimations in code

```python
'''
Developed by Abhijith Boppe - linkedin.com/in/abhijith-boppe/
'''
from intimations import *

#get a beep sound
beep(sound='info', count=3, interval=3.0)

#get a push intimation
push('intimation', 'By Abhijith Boppe', duration:int=10, icon=r"sign")

#get an intimation/message to your telegram mobile app
BOT_API = 'YOUR BOT API'
CHAT_ID = 'ONE OF YOUR CHAT ID'

telegram(botAPI=BOT_API, chatID=CHAT_ID, title='TITLE', message'YOUR MESSAGE')

#Flash icon on taskbar (windows platform only)
flashIcon(count:int=3, interval:float=1.5)
```

### Have a look at Stock icons and sounds

```python
'''
Developed by Abhijith Boppe - linkedin.com/in/abhijith-boppe/
'''
from intimations import *

for type_ in ['info', 'danger', 'warning' , 'success']:
beep(sound=type_)
push(title='Testing', message=f'This is {type_} message.',icon=type_)
time.sleep(3)
```

Licensed under the [MIT License](LICENSE)