Metadata-Version: 2.1
Name: notifly
Version: 1.1.3
Summary: Telegram Bot Notifier
Home-page: https://github.com/rexdivakar/Telegram-Notifly
Author: Divakar R
Author-email: rexdivakar@hotmail.com
License: MIT
Description: # Telegram-Notify
        ![GitHub issues](https://img.shields.io/github/issues-raw/rexdivakar/telegram-notifly?logo=github&style=for-the-badge)
        ![Discord](https://img.shields.io/discord/760088481224851476?label=DISCORD&logo=discord&logoColor=green&style=for-the-badge)
        ![PyPI](https://img.shields.io/pypi/v/notifly?logo=github&style=for-the-badge)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/notifly?color=green&style=for-the-badge&logo=github)
        
        ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/rexdivakar/telegram-notifly/Python%20application?&style=flat-square)
        ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/rexdivakar/telegram-notifly/Upload%20Python%20Package?label=Upload%20Python%20Package&style=flat-square)
        
        
        ## Table of Contents
        * [About the package](#about-the-package)
          * [Built With](#built-with)
        * [Install the package](#install-the-package)
          * [Working of the tool](#working-of-the-tool)
          * [Prerequisites](#prerequisites)
        * [Contributing](#contributing)
        
        ## About the package
        Telegram Bot to push notifications during an event trigger.
        
        ## Built With
        * [Python][1]
        
        ## Install the package
        Run the following terminal commands to install the package on the given distros.
        * Termux :
        ```
        pkg install python3 
        ```
        ```
        pip3 install notifly
        ```
        * Ubuntu/Debian
        ```
        sudo apt install python3-pip
        ```
        ```
        pip3 install notifly
        ```
        * Arch
        ```
        sudo pacman -S python3-pip
        ```
        ```
        pip3 install notifly
        ```
        ***This may take a while depending on the network speed.***
        ### Prerequisites
        * Python3<br>
        It is preinstalled in Ubuntu 20.04. To check the version use command :
        ```
        python3 --version
        ```
        If it is not preinstalled for some reason, proceed [here][4] and download as per requirement.
        
        Run the following command in terminal to download the required packags for running the tool locally : 
        * Using requirements file :
        ```
        pip3 install -r requirements.txt
        ```
        * Directly download :
        ```
        pip3 install requests==2.20.0
        ```
        ### Working of the tool
        To see how the tool works, create a [telegram bot][2].
        
        1. ***Run sample code***
        ```python
        from telegram import notifly
        
        token = input("Enter bot token : ")
        bot=notifly.BotHandler(token)
        text = input("Enter text message : ")
        print(bot.send_message(text))
        opt_image = input("Do you want to send image ?")
        if(opt_image=='y' or opt_image=='Y'):
            img_path = input("Enter full image path : ")
            bot.send_image(img_path)
        ```
        
        ## Contributing
        1. Fork the Project
        1. Create your Feature Branch 
        ```
        git checkout -b feature/mybranch
        ```
        1. Commit your Changes 
        ```
        git commit -m 'Add something'
        ```
        1. Push to the Branch 
        ```
        git push origin feature/mybranch
        ```
        1. Open a Pull Request
        
        *Follow the given commands or use the amazing GitHub GUI*
        <br>**Happy Contributing** :smiley:
        
        [contributors-shield]: https://img.shields.io/github/contributors/rexdivakar/Telegram-Notifly.svg?style=flat-square
        [contributors-url]: https://github.com/rexdivakar/Telegram-Notifly/graphs/contributors
        [forks-shield]: https://img.shields.io/github/forks/rexdivakar/Telegram-Notifly.svg?style=flat-square
        [forks-url]: https://github.com/rexdivakar/Telegram-Notifly/network/members
        [stars-shield]: https://img.shields.io/github/stars/rexdivakar/Telegram-Notifly.svg?style=flat-square
        [stars-url]: https://github.com/rexdivakar/Telegram-Notifly/stargazers
        [issues-shield]: https://img.shields.io/github/issues/rexdivakar/Telegram-Notifly.svg?style=flat-square
        [issues-url]: https://github.com/rexdivakar/Telegram-Notifly/issues
        [license-shield]: https://img.shields.io/github/license/rexdivakar/Telegram-Notifly.svg?style=flat-square
        [license-url]: https://github.com/rexdivakar/Telegram-Notifly/blob/master/LICENSE.txt
        [0]:https://core.telegram.org/bots
        [1]:https://www.python.org/
        [2]:https://telegram.org/blog/bot-revolution
        [4]:https://www.python.org/downloads/
        
Keywords: Telegram
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
