{
    "info": {
        "author": "Nicholas de Jong",
        "author_email": "contact@nicholasdejong.com",
        "bugtrack_url": null,
        "classifiers": [
            "Intended Audience :: Information Technology",
            "Intended Audience :: System Administrators",
            "License :: OSI Approved :: BSD License",
            "Programming Language :: Python :: 3"
        ],
        "description": "# Telegram Interface\n\n[![PyPi](https://img.shields.io/pypi/v/telegram-interface-cli.svg)](https://pypi.org/project/telegram-interface-cli/)\n[![Build Status](https://api.travis-ci.org/ndejong/telegram-interface.svg?branch=master)](https://api.travis-ci.org/ndejong/telegram-interface)\n\nA quick tool for listing the Telegram Messenger groups that a user-account is invited into and\nlisting the users within groups.\n\n## Project\n* [github.com/ndejong/telegram-interface](https://github.com/ndejong/telegram-interface)\n\n## Install\n#### via PyPi\n```bash\npip3 install telegram-interface-cli\n```\n\n#### via Source\n```bash\ngit clone https://github.com:ndejong/telegram-interface\ncd telegram-interface\npython3 -m venv venv\n./venv/bin/activate\npip3 install -r requirements.txt\n```\n\n## Prerequisites\n* A [Telegram Messenger](https://telegram.org/) account invited into one or more group chat channels.\n* Setup API credentials on the Telegram Messenger account [core.telegram.org/api/obtaining_api_id](https://core.telegram.org/api/obtaining_api_id)\n\n## Configuration\n\nConfiguration is via a YAML format as per the following example\n```yaml\n\n---\n\ntelegram_interface_cli:\n\n#\n#  api_id: env:telegram_api_id\n#  api_hash: env:telegram_api_hash\n#  api_phone: env:telegram_api_phone\n#\n\n  api_id: '123456'\n  api_hash: '0123456789abcdef0123456789abcdef'\n  api_phone: '12125551234'\n\n  session_filename: '~/.telegram.session'\n\n```\n\nLoading environment variables into the configuration file is possible using the env name with an \n`env:` prefix, for example\n```yaml\n  api_id: env:telegram_api_id\n``` \nIn this case the `api_id` value is loaded loaded from the `telegram_api_id` env value.\n\n#### Configuration file location\nThe following file location are checked for the configuration file if the `TELEGRAMINTERFACECLI_CONFIG_FILENAME` env value is not set.\n```text\n    __CWD__/telegram_interface_cli.yml\n    __CWD__/telegram_interface_cli.yaml\n    __CWD__/telegram-interface.yml\n    __CWD__/telegram-interface.yaml\n    ~/.telegram-interface\n    /etc/telegram-interface/telegram-interface.yml\n    /etc/telegram-interface/telegram-interface.yaml\n```\n\n#### Environment Variables\n* `TELEGRAMINTERFACECLI_CONFIG_FILENAME` - configuration file override.\n\n## Outputs\nBy default output is in JSON data-structures making it easier to chain with other tools such as `jq` for further parsing \nand filtering if required.\n\nAdditionally, CSV outputs are possible using the `--csv` argument. \n\nLog status messages are sent to stderr and do not get in the way of pipe style tool chaining.\n\n\n\n### Usage\n```\n$ telegram-interface --help\nusage: telegram-interface [-h] [-f <filename>] [-o <filename>] [-c] [-g] [-u]\n                          [-C <filename>] [-d]\n\nTelegram Interface v0.1.1\n\noptional arguments:\n  -h, --help     show this help message and exit\n  -f <filename>  Data filename to use. If the file already exists it will be\n                 loaded as input without connecting to Telegram, thus allowing\n                 a reload of a previous run. By default a filename is auto-\n                 generated in the <cwd>.\n  -o <filename>  Output filename, by default to <stdout>.\n  -c, --csv      Output in flattened CSV format.\n  -g, --group    Output names of groups that the Telegram user is a member of,\n                 combine with -u to obtain the users within these groups.\n  -u, --user     Output names of the users that the Telegram user has\n                 visibility on.\n  -C <filename>  Override the configuration file to read, else search for\n                 telegram-interface.yml in common paths.\n  -d, --debug    Debug level logging output (default: False).\n\nA quick tool for listing the Telegram Messenger groups that a user-account is\ninvited into and listing the users within groups.\n```\n\n****\n\n## Authors\n[Nicholas de Jong](https://nicholasdejong.com)\n\n## License\nBSD-2-Clause - see LICENSE file for full details.\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/ndejong/telegram-interface",
        "keywords": "telegram telegram-group",
        "license": "BSD 2-Clause",
        "maintainer": "",
        "maintainer_email": "",
        "name": "telegram-interface-cli",
        "package_url": "https://pypi.org/project/telegram-interface-cli/",
        "platform": "",
        "project_url": "https://pypi.org/project/telegram-interface-cli/",
        "project_urls": {
            "Homepage": "https://github.com/ndejong/telegram-interface"
        },
        "release_url": "https://pypi.org/project/telegram-interface-cli/0.1.3/",
        "requires_dist": [
            "argparse",
            "telethon"
        ],
        "requires_python": "",
        "summary": "A quick tool for listing the Telegram Messenger groups that a user is within.",
        "version": "0.1.3"
    },
    "last_serial": 5966942,
    "releases": {
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6d4988034d6822eea4c2db9656c3741d",
                    "sha256": "83081014bf82732721c65a551e9485f974de0f248a65dcb97969340ae67258a0"
                },
                "downloads": -1,
                "filename": "telegram_interface_cli-0.1.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "6d4988034d6822eea4c2db9656c3741d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 12159,
                "upload_time": "2019-10-13T09:41:59",
                "url": "https://files.pythonhosted.org/packages/d1/89/09d1b7043003894a233eb05a16247ebde4b844500794d986c462645d18c2/telegram_interface_cli-0.1.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "313f9b41ab0477f266a9b9218ebc6b05",
                    "sha256": "375eaaa8603a973e892d30ef87819ab9e56ed794e3e9b1e04367272d44118fd9"
                },
                "downloads": -1,
                "filename": "telegram-interface-cli-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "313f9b41ab0477f266a9b9218ebc6b05",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10241,
                "upload_time": "2019-10-13T09:42:01",
                "url": "https://files.pythonhosted.org/packages/90/70/30d1db113aa23c828665cb92ea87a6d7bd52ac6d7d155c20e7a5fe80c448/telegram-interface-cli-0.1.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "6d4988034d6822eea4c2db9656c3741d",
                "sha256": "83081014bf82732721c65a551e9485f974de0f248a65dcb97969340ae67258a0"
            },
            "downloads": -1,
            "filename": "telegram_interface_cli-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6d4988034d6822eea4c2db9656c3741d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 12159,
            "upload_time": "2019-10-13T09:41:59",
            "url": "https://files.pythonhosted.org/packages/d1/89/09d1b7043003894a233eb05a16247ebde4b844500794d986c462645d18c2/telegram_interface_cli-0.1.3-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "313f9b41ab0477f266a9b9218ebc6b05",
                "sha256": "375eaaa8603a973e892d30ef87819ab9e56ed794e3e9b1e04367272d44118fd9"
            },
            "downloads": -1,
            "filename": "telegram-interface-cli-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "313f9b41ab0477f266a9b9218ebc6b05",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10241,
            "upload_time": "2019-10-13T09:42:01",
            "url": "https://files.pythonhosted.org/packages/90/70/30d1db113aa23c828665cb92ea87a6d7bd52ac6d7d155c20e7a5fe80c448/telegram-interface-cli-0.1.3.tar.gz"
        }
    ]
}