{
    "info": {
        "author": "Anish Mashankar",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "# Elasticsearch cat CLI\nBasic Elasticsearch cat API command line wrapper with multi-cluster support\n\n[![Build Status](https://travis-ci.org/anishmcloud/escat.svg?branch=master)](https://travis-ci.org/anishmcloud/escat)\n[![PyPI](https://img.shields.io/pypi/v/escat.svg)](https://pypi.org/project/escat/)\n#### Features:\n- Complete coverage of all Elasticsearch `cat` modules\n- Exposed `cat` API call options as command line arguments\n- Get output in form of json, or text\n- Manage multiple clusters using profiles\n- Support for SSL and Password authentication\n\n### Installation:\n**Requirements**:\n- python3\n- pip\n\n**Installation instructions**\n- Install using pip\n```\npip install escat\n```\n- A config file will be automatically created in the home directory of the current user called `~/escat.yml`. This file will have the default configuration:\n```yaml\nclusters:\n  default:\n    hosts: [\"http://localhost:9200\"]\n```\n\n### Configuration\nExample configuration\n```yaml\nclusters:\n  default:\n    hosts: ['http://localhost:9200']\n#    auth:\n#      username: 'elastic'\n#      password:\n#        ask: yes\n#        value: 'elastic'\n#    ssl:\n#      enabled: no\n#      cert: ''\n#      ca: []\n#      private_key: ''\n#      verify_certs: yes\n```\nThe contents of the file are pretty self explanatory. The keys: `auth` and `ssl` are disabled but visible for reference on how to configure authentication for the requests sent to Elasticsearch. Below mentioned is a multi cluster configuration. For the rest of the documentation, we are going to use this configuration file to run commands:\n```yaml\nclusters:\n  default:\n    hosts: ['http://localhost:9200']\n  dev:\n    hosts: ['https://dev-es-1:9200', 'https://dev-es-2:9200']\n  prod:\n    hosts: ['https://prod-es-1:9200', 'https://prod-es-2:9200']\n    ssl:\n      enabled: yes\n      cert: '~/.openssl/certs/prod-es-cert.cert'\n      ca: ['~/.openssl/cas/prod-ca-1.cert', '~/.openssl/cas/prod-ca-2.cert']\n      private_key: '~/.openssl/certs/prod-es-cert.key'\n      verify_certs: yes\n```\nIf you set a config like this:\n```yaml\nclusters:\n  default:\n    hosts: ['http://localhost:9200']\n    auth:\n      username: 'elastic'\n      password:\n        ask: yes\n```\nYou will be asked for the password on a command line.\n### Running\nTo understand some options, please refer the config example directly above.\n\nGet help for commands\n```\nescat -h\n```\nGet cluster health for default cluster\n```l\nescat health\n```\nGet count for selective indices in the dev cluster\n```\nescat --cluster dev count --indices \"dev-test\"\n```\nGet recovery information on prod cluster in json format\n```\nescat --cluster prod --format json recovery\n```\nUse a different config file\n```\nescat --config ~/.es.yml --cluster dev health\n```\n\n### Contributing\nPlease raise github issues related to questions, feature requests or troubleshooting. Also, to make debug person's life easier, one should always include the following information:\n- Command ran\n- Operating system\n- Python version\n- Elasticsearch version\n\nCurrently, the escat is only tested on Python 3.6.5 on Ubuntu 16.04, Windows 10, and Mac OSX.\nPRs are welcome. Do mention the description in brief what the PR would fix. If the PR is in a form of checklist, it would be amazing.\n\n### Resources\n[Elasticsearch cat API](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html)",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/anishmcloud/escat",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "escat",
        "package_url": "https://pypi.org/project/escat/",
        "platform": "",
        "project_url": "https://pypi.org/project/escat/",
        "project_urls": {
            "Homepage": "https://github.com/anishmcloud/escat"
        },
        "release_url": "https://pypi.org/project/escat/1.0.7/",
        "requires_dist": null,
        "requires_python": ">=3.0",
        "summary": "Command line wrapper for Elasticsearch CAT API",
        "version": "1.0.7"
    },
    "last_serial": 4161884,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c8c2d352d2b0699d655b82747b1cc2f0",
                    "sha256": "54b3afca18cb075ad099ea99d5cdcb85a32822d1192c92cd3d5a702c69e9f306"
                },
                "downloads": -1,
                "filename": "escat-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c8c2d352d2b0699d655b82747b1cc2f0",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.0",
                "size": 7006,
                "upload_time": "2018-07-07T17:16:45",
                "url": "https://files.pythonhosted.org/packages/c3/a6/d0bb2afa636cdaf3622cbbcb5c7f943763d4f032b2506364f3014f7c03a4/escat-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "c24cd6dcc1e4a1b51321220fc8f29458",
                    "sha256": "61cb017db81496a0ef76b75a251826f065e3ce739376da3de8b5ff6e2b8d2076"
                },
                "downloads": -1,
                "filename": "escat-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "c24cd6dcc1e4a1b51321220fc8f29458",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.0",
                "size": 5507,
                "upload_time": "2018-07-07T17:16:46",
                "url": "https://files.pythonhosted.org/packages/9a/59/0d9356174f05e486280ce3476fb2e001b32524431cc662eec7752638786e/escat-1.0.0.tar.gz"
            }
        ],
        "1.0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "85efe75c05db113b893f8d3a25020e34",
                    "sha256": "712e37c3f7fa2c0fd731f7017fb376d066fc79293ecfd1b91f55371187edfd17"
                },
                "downloads": -1,
                "filename": "escat-1.0.6.tar.gz",
                "has_sig": false,
                "md5_digest": "85efe75c05db113b893f8d3a25020e34",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.0",
                "size": 5815,
                "upload_time": "2018-07-19T15:04:46",
                "url": "https://files.pythonhosted.org/packages/c8/22/ef1cec0ad7c7b28e7f55634c66558159503ab5f2069b6421090823737179/escat-1.0.6.tar.gz"
            }
        ],
        "1.0.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4fb5e75680cb3a52b03b77faaee86c81",
                    "sha256": "bf72e9dbd08dd35aec9a89968d967e1e0a4665ee3d5a0229fd95ff5ad58cd537"
                },
                "downloads": -1,
                "filename": "escat-1.0.7.tar.gz",
                "has_sig": false,
                "md5_digest": "4fb5e75680cb3a52b03b77faaee86c81",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.0",
                "size": 5826,
                "upload_time": "2018-08-12T15:22:35",
                "url": "https://files.pythonhosted.org/packages/af/a8/ff9a92570abb5e4d5abae0c103e2221f69a3dcc535ae5dba65e8509d6120/escat-1.0.7.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "4fb5e75680cb3a52b03b77faaee86c81",
                "sha256": "bf72e9dbd08dd35aec9a89968d967e1e0a4665ee3d5a0229fd95ff5ad58cd537"
            },
            "downloads": -1,
            "filename": "escat-1.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "4fb5e75680cb3a52b03b77faaee86c81",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.0",
            "size": 5826,
            "upload_time": "2018-08-12T15:22:35",
            "url": "https://files.pythonhosted.org/packages/af/a8/ff9a92570abb5e4d5abae0c103e2221f69a3dcc535ae5dba65e8509d6120/escat-1.0.7.tar.gz"
        }
    ]
}