Skip to main content

A package for remote program alerts,prints and notification through Telegram

Project description

Project Description

GPLv3 License

pyteleprint

pyteleprint is a package for remote prints, notification and alerts for python programs. The notification mechanism is done via Telegram.

Why should I use this?

This is meant for users who want print() to be a remote notification and alert mechanism if they are not present at their workstation when the program is being executed or for a persisting python application.

Features

  • Remote alerts
  • Remote print
  • Remote notification

Requirements

  • Requires Python -v >= 3.4.0
  • Telegram App

Installation

$ pip install pyteleprint

Initial Preparations

The Telegram app must be installed into your mobile system.

First, create a personal bot using (@BotFather). Once the creation process is done, you will receive an API token. Note this API Token for further use.

Using pyteleprint

Create a new script or use shell to execute the following code

from pyteleprint.printer.chat_extract import ChatIDExtractor

API_TOKEN = "YOUR_NEW_BOT_API_TOKEN" # Obtained from creating a bot through BotFather
ChatIDExtractor(API_TOKEN).start()

Once the script is executed, the program would start polling for messages to get chat id. Send a message to your new bot. This will help the program extract the chat id. Use this chat id to send notifications and alerts.

If in future, you delete or lose the chat thread, you can redo the above process to get the new chat id.

This chat id can be used statically in any application at any point in time iff the chat thread with the bot exists. But, if the user deletes the chat with their bot then they have to re-extract the chat id since there would be a new chat thread to communicate with the bot.

Now, you have the API Token and the chat id with you, use them to create a Printer object in your scripts and use the print() method to send notifications,prints and alerts.

from pyteleprint.printer.printer import Printer

API_TOKEN = "YOUR_BOT_API_TOKEN"
CHAT_ID = 12345 # Chat id obtained from ChatIDExtractor().start()
p = Printer(API_TOKEN,CHAT_ID)

p.print("Hello World")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyteleprint-1.0.4.tar.gz (2.2 kB view details)

Uploaded Source

Built Distribution

pyteleprint-1.0.4-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file pyteleprint-1.0.4.tar.gz.

File metadata

  • Download URL: pyteleprint-1.0.4.tar.gz
  • Upload date:
  • Size: 2.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.4.2 requests/2.21.0 setuptools/43.0.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.4.0

File hashes

Hashes for pyteleprint-1.0.4.tar.gz
Algorithm Hash digest
SHA256 5727cadf8d419d67cec061a4049c808e998b812242df3cd2821f53f7b52350ef
MD5 cc9a03158f4c775929d927ce37784a20
BLAKE2b-256 7b378f2df9a25e0fea696a0de71ac5e1acc67b9d3c34527f7cd7e1880eb95cff

See more details on using hashes here.

File details

Details for the file pyteleprint-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: pyteleprint-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.4.2 requests/2.21.0 setuptools/43.0.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.4.0

File hashes

Hashes for pyteleprint-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7d98efd3fee9f346b33482499e4c8636e0f966b5635e56a20b20213fed6a17c2
MD5 032a06e908fd22b047c69fb4f2af7eae
BLAKE2b-256 dba15f74fd437e1efbf5052d60991065ce62ac0db1f06d0e80c715f5460a1614

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page