pykli


Namepykli JSON
Version 1.1.4 PyPI version JSON
download
home_pagehttps://github.com/eshepelyuk/pykli
SummaryInteractive ksqlDB command line client with autocompletion and syntax highlighting
upload_time2023-07-25 17:47:26
maintainer
docs_urlNone
authorIevgenii Shepeliuk
requires_python>=3.10,<4.0
licenseMIT
keywords cli kafka tui confluent ksql ksqldb
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pyKLI

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
[![PyPI version](https://badge.fury.io/py/pykli.svg)](https://badge.fury.io/py/pykli)
![PyPI - License](https://img.shields.io/pypi/l/pykli)

Interactive [ksqlDB](https://ksqldb.io/) command line client
with autocompletion and syntax highlighting written in Python.

This project is in an early preview stage. Please try it and provide your feedback.

PRs and suggestions are welcome.

## Installation

* Latest released version

    ```sh
    pip install pykli
    ```

* From latest source code

    ```sh
    pip install -U git+https://github.com/eshepelyuk/pykli@main
    ```

## Supported KSQL commands

* `SHOW`, `LIST`
* `DESCRIBE`, without `EXTENDED`
* `DROP`
* `CREATE`
* `RUN SCRIPT`
* `TERMINATE`
* `SELECT`  for Pull queries
* `INSERT`
* `DEFINE`, `UNDEFINE`

## TODO (prioritized)

* Semantic versioned release and publish to PyPI
* Auto detect when needed output via pager
* Push queries, i.e. with `EMIT CHANGES` for `SELECT` statement
* In-place KSQL editing with default editor
* KSQL syntax support with Pygments
* Metadata autocompletion
    * table ans stream names
    * column names and functions in queries
    * topic and connector names
    * session variables
    * attributes of `WITH` blocks
* More configuration options and configuration file
    * pygments theme
    * server profiles
    * etc etc
* Internal help
* `PAUSE` / `RESUME`
* `DESCRIBE ... EXTENDED`
* `EXPLAIN`



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/eshepelyuk/pykli",
    "name": "pykli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "cli,kafka,tui,confluent,ksql,ksqldb",
    "author": "Ievgenii Shepeliuk",
    "author_email": "eshepelyuk@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/5a/18/dfff3b428a79ac6e53a86c243501b6528c23763b943d85d69a724d86001e/pykli-1.1.4.tar.gz",
    "platform": null,
    "description": "# pyKLI\n\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)\n[![PyPI version](https://badge.fury.io/py/pykli.svg)](https://badge.fury.io/py/pykli)\n![PyPI - License](https://img.shields.io/pypi/l/pykli)\n\nInteractive [ksqlDB](https://ksqldb.io/) command line client\nwith autocompletion and syntax highlighting written in Python.\n\nThis project is in an early preview stage. Please try it and provide your feedback.\n\nPRs and suggestions are welcome.\n\n## Installation\n\n* Latest released version\n\n    ```sh\n    pip install pykli\n    ```\n\n* From latest source code\n\n    ```sh\n    pip install -U git+https://github.com/eshepelyuk/pykli@main\n    ```\n\n## Supported KSQL commands\n\n* `SHOW`, `LIST`\n* `DESCRIBE`, without `EXTENDED`\n* `DROP`\n* `CREATE`\n* `RUN SCRIPT`\n* `TERMINATE`\n* `SELECT`  for Pull queries\n* `INSERT`\n* `DEFINE`, `UNDEFINE`\n\n## TODO (prioritized)\n\n* Semantic versioned release and publish to PyPI\n* Auto detect when needed output via pager\n* Push queries, i.e. with `EMIT CHANGES` for `SELECT` statement\n* In-place KSQL editing with default editor\n* KSQL syntax support with Pygments\n* Metadata autocompletion\n    * table ans stream names\n    * column names and functions in queries\n    * topic and connector names\n    * session variables\n    * attributes of `WITH` blocks\n* More configuration options and configuration file\n    * pygments theme\n    * server profiles\n    * etc etc\n* Internal help\n* `PAUSE` / `RESUME`\n* `DESCRIBE ... EXTENDED`\n* `EXPLAIN`\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Interactive ksqlDB command line client with autocompletion and syntax highlighting",
    "version": "1.1.4",
    "project_urls": {
        "Homepage": "https://github.com/eshepelyuk/pykli",
        "Repository": "https://github.com/eshepelyuk/pykli"
    },
    "split_keywords": [
        "cli",
        "kafka",
        "tui",
        "confluent",
        "ksql",
        "ksqldb"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "450833914aaffbd6d316e8d6871ecf817f129800f71a148a010084bedf99f348",
                "md5": "584009aefa9e6f743cd966a8bef7e45c",
                "sha256": "41617952236aa07c854a24ab065b6684356328c30810beaf1fb6aea752ea8de7"
            },
            "downloads": -1,
            "filename": "pykli-1.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "584009aefa9e6f743cd966a8bef7e45c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 11398,
            "upload_time": "2023-07-25T17:47:25",
            "upload_time_iso_8601": "2023-07-25T17:47:25.051193Z",
            "url": "https://files.pythonhosted.org/packages/45/08/33914aaffbd6d316e8d6871ecf817f129800f71a148a010084bedf99f348/pykli-1.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5a18dfff3b428a79ac6e53a86c243501b6528c23763b943d85d69a724d86001e",
                "md5": "42444e6adf6a750c6893948cb543f4f0",
                "sha256": "832fbb0a54466028715b4ad30ea07138d1c3e7c35f0def785cc4f6fe93110269"
            },
            "downloads": -1,
            "filename": "pykli-1.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "42444e6adf6a750c6893948cb543f4f0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 9816,
            "upload_time": "2023-07-25T17:47:26",
            "upload_time_iso_8601": "2023-07-25T17:47:26.553597Z",
            "url": "https://files.pythonhosted.org/packages/5a/18/dfff3b428a79ac6e53a86c243501b6528c23763b943d85d69a724d86001e/pykli-1.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-25 17:47:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "eshepelyuk",
    "github_project": "pykli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pykli"
}
        
Elapsed time: 0.09618s