Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A quick tool for listing the Telegram Messenger groups that a user is within.

Project description

Telegram Interface

PyPi Build Status

A quick tool for listing the Telegram Messenger groups that a user-account is invited into and listing the users within groups.

Project

Install

via PyPi

pip3 install telegram-interface-cli

via Source

git clone https://github.com:ndejong/telegram-interface
cd telegram-interface
python3 -m venv venv
./venv/bin/activate
pip3 install -r requirements.txt

Prerequisites

Configuration

Configuration is via a YAML format as per the following example

---

telegram_interface_cli:

#
#  api_id: env:telegram_api_id
#  api_hash: env:telegram_api_hash
#  api_phone: env:telegram_api_phone
#

  api_id: '123456'
  api_hash: '0123456789abcdef0123456789abcdef'
  api_phone: '12125551234'

  session_filename: '~/.telegram.session'

Loading environment variables into the configuration file is possible using the env name with an env: prefix, for example

  api_id: env:telegram_api_id

In this case the api_id value is loaded loaded from the telegram_api_id env value.

Configuration file location

The following file location are checked for the configuration file if the TELEGRAMINTERFACECLI_CONFIG_FILENAME env value is not set.

    __CWD__/telegram_interface_cli.yml
    __CWD__/telegram_interface_cli.yaml
    __CWD__/telegram-interface.yml
    __CWD__/telegram-interface.yaml
    ~/.telegram-interface
    /etc/telegram-interface/telegram-interface.yml
    /etc/telegram-interface/telegram-interface.yaml

Environment Variables

  • TELEGRAMINTERFACECLI_CONFIG_FILENAME - configuration file override.

Outputs

By default output is in JSON data-structures making it easier to chain with other tools such as jq for further parsing and filtering if required.

Additionally, CSV outputs are possible using the --csv argument.

Log status messages are sent to stderr and do not get in the way of pipe style tool chaining.

Usage

$ telegram-interface --help
usage: telegram-interface [-h] [-f <filename>] [-o <filename>] [-c] [-g] [-u]
                          [-C <filename>] [-d]

Telegram Interface v0.1.1

optional arguments:
  -h, --help     show this help message and exit
  -f <filename>  Data filename to use. If the file already exists it will be
                 loaded as input without connecting to Telegram, thus allowing
                 a reload of a previous run. By default a filename is auto-
                 generated in the <cwd>.
  -o <filename>  Output filename, by default to <stdout>.
  -c, --csv      Output in flattened CSV format.
  -g, --group    Output names of groups that the Telegram user is a member of,
                 combine with -u to obtain the users within these groups.
  -u, --user     Output names of the users that the Telegram user has
                 visibility on.
  -C <filename>  Override the configuration file to read, else search for
                 telegram-interface.yml in common paths.
  -d, --debug    Debug level logging output (default: False).

A quick tool for listing the Telegram Messenger groups that a user-account is
invited into and listing the users within groups.

Authors

Nicholas de Jong

License

BSD-2-Clause - see LICENSE file for full details.

Project details


Release history Release notifications

Download files

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

Files for telegram-interface-cli, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size telegram_interface_cli-0.1.3-py3-none-any.whl (12.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size telegram-interface-cli-0.1.3.tar.gz (10.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page