Skip to main content

Telegram client in Ncurses, written in Python

Project description

Spike is a Telegram client with an Ncurses terminal user interface capable of handling text messages, currently in state of development.

Use

Launch the program with the spike-telegram command. To send a message, just select and enter the desired chat, type the message and press enter.

These are the keybindings:

Key

Action

Arrow up

Switch to upper chat

Arrow down

Switch to lower chat

Arrow right

Enter the selected chat

Arrow left

Leave current chat

Page up

Scroll up the dialog

Page down

Scroll down the dialog

Enter

Send message

Ctrl+q

Quit program

NOTE: if you experience any problems closing the program with Ctrl+q, executing stty -ixon before Spike might solve it.

Configuration

A configuration file will be created in ~your_user/.config/spikerc. There you can set your Telegram credentials and other options such us desktop notifications or privacy settings.

Installation

First of all, you must get an api_id and api_hash in https://my.telegram.org/. Go to ‘API development tools’ and fill out the form. Once you install Spike, write those keys in the configuration file, plus your phone number.

Arch Linux installation

  • Clone this repository

  • Go to distro-packages/archlinux/python-telegram. There you will find the PKGBUILD to install python-telegram, the main Spike dependency

  • Install it with makepkg -csi --asdeps

  • Go to ../spike-telegram

  • Install Spike with makepkg -csi NOTE: This package has libnotify and python-emoji (AUR) as dependencies. If you wish to disable notifications or emoji support in the Spike configuration file, you can remove the dependencies from the PKGBUILD before installing it

  • Run Spike to generate a template of the configuration file and fill it with your Telegram credentials and preferences

Gentoo Linux installation

  • Clone this repository

  • Go to distro-packages/gentoo

  • Copy the dev-python and net-im folders to your local repository (You can find how to create one in https://wiki.gentoo.org/wiki/Handbook:AMD64/Portage/CustomTree#Defining_a_custom_repository )

  • Run emerge -pv spike-telegram and add the relevant keywords and use flags to your Portage configuration

  • Install Spike with emerge -av spike-telegram

  • Run Spike to generate a template of the configuration file and fill it with your Telegram credentials and preferences

Other distributions

  • Install pip, the Python Package Manager

  • Install Spike with pip install spike-telegram

  • Run Spike to generate a template of the configuration file and fill it with your Telegram credentials and preferences

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

spike-telegram-0.1.1.tar.gz (23.9 kB view details)

Uploaded Source

File details

Details for the file spike-telegram-0.1.1.tar.gz.

File metadata

  • Download URL: spike-telegram-0.1.1.tar.gz
  • Upload date:
  • Size: 23.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.7

File hashes

Hashes for spike-telegram-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b681da1f7df49b58a605844ef2db1a0b867f3718d08110d0821b43759d6c7180
MD5 8bab92fc84466b3df1ac02b1717aae81
BLAKE2b-256 d98f37e7a3c6585e9e26533f18ddf85fe9d7baa83749921ffc0ee94046a71d76

See more details on using hashes here.

Supported by

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