https://github.com/ndejong/telegram-interface
A quick tool for dumping out the Telegram Messenger groups that a user-account is in, listing all users within those groups.
https://github.com/ndejong/telegram-interface
telegram telegram-group
Last synced: about 1 month ago
JSON representation
A quick tool for dumping out the Telegram Messenger groups that a user-account is in, listing all users within those groups.
- Host: GitHub
- URL: https://github.com/ndejong/telegram-interface
- Owner: ndejong
- License: bsd-2-clause
- Created: 2019-08-04T09:17:02.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-08T11:27:33.000Z (over 5 years ago)
- Last Synced: 2025-02-10T06:14:12.115Z (3 months ago)
- Topics: telegram, telegram-group
- Language: Python
- Homepage:
- Size: 51.8 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegram Interface
[](https://pypi.python.org/pypi/telegram-interface-cli/)
[](https://github.com/ndejong/telegram-interface/)
[](https://travis-ci.org/ndejong/telegram-interface/)
[](https://github.com/ndejong/telegram-interface)
A quick tool for listing the Telegram Messenger groups that a user-account is invited into and
listing the users within groups.
## Project
* [github.com/ndejong/telegram-interface](https://github.com/ndejong/telegram-interface)
## Install
#### via PyPi
```bash
pip3 install telegram-interface-cli
```
#### via Source
```bash
git clone https://github.com:ndejong/telegram-interface
cd telegram-interface
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
python3 setup.py clean
python3 setup.py test
python3 setup.py install
```
## Prerequisites
* A [Telegram Messenger](https://telegram.org/) account invited into one or more group chat channels.
* Setup API credentials on the Telegram Messenger account [core.telegram.org/api/obtaining_api_id](https://core.telegram.org/api/obtaining_api_id)
## Configuration
Configuration is via a YAML format as per the following example
```yaml
---
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
```yaml
api_id: env:telegram_api_id
```
In this case the `api_id` value is loaded loaded from the `telegram_api_id` env value.
#### 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
```
usage: telegram-interface [-h] [-c ] [-f ] [-o ]
[-g] [-u] [--csv] [-d]
Telegram Interface v0.1.7
optional arguments:
-h, --help show this help message and exit
-c Configuration file to use (required)
-f Data filename to use. If the data-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 current-working-directory.
-o Output filename, by default output is sent to .
-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.
--csv Output in flattened CSV format.
-d, --debug Debug level logging output.
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](https://nicholasdejong.com)
## License
BSD-2-Clause - see LICENSE file for full details.