# TailK
![pyversions](https://img.shields.io/pypi/pyversions/tailk.svg) [![PyPi Status](https://img.shields.io/pypi/v/tailk.svg)](https://pypi.org/project/tailk/) ![PyPI - Downloads](https://img.shields.io/pypi/dm/tailk) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ffaraone/tailk/test.yml?branch=master) ![Codecov](https://img.shields.io/codecov/c/github/ffaraone/tailk)
## Introduction
`TaikK` is a small utility to tail logs from multiple Kubernetes pods.
## Installation
`TailK` requires Python 3.8+ and `kubectl` available in your shell.
### Using pip
```
$ pip install tailk
```
### Using Homebrew
```
$ brew update
$ brew tap ffaraone/birre
$ brew install ffaraone/birre/tailk
```
## Usage
### Basic usage
```
$ tailk pattern1 [...]
```
where `pattern1` is any valid Python regular expression.
> Multiple patterns are combined with a logical `OR`.
### Advanced usage
You may want to highlight portions of the log. In this case you can provide highlighting patterns in the following way:
```
$ tailk pattern1 --highlight hl-pattern-1 [--highlight hl-pattern-2]
```
where `hl-pattern-1` is any valid Python regular expression.
You can also customize the style for highlight. In this case your patterns must be specified using named capturing groups
```
$ tailk pattern1 --highlight "(?P<hello>HELLO)" --style "hello:underline magenta"
```
## License
`TailK` is released under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
Raw data
{
"_id": null,
"home_page": "https://github.com/ffaraone/tailk",
"name": "tailk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4",
"maintainer_email": "",
"keywords": "tail,log,kubernetes,pods",
"author": "Francesco Faraone",
"author_email": "ffaraone@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/37/71/0aca16f07c41b90a4211ad52b46e4406f05d128ff20b3006b1e3a87bd1fc/tailk-0.1.0.tar.gz",
"platform": null,
"description": "# TailK\n\n![pyversions](https://img.shields.io/pypi/pyversions/tailk.svg) [![PyPi Status](https://img.shields.io/pypi/v/tailk.svg)](https://pypi.org/project/tailk/) ![PyPI - Downloads](https://img.shields.io/pypi/dm/tailk) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ffaraone/tailk/test.yml?branch=master) ![Codecov](https://img.shields.io/codecov/c/github/ffaraone/tailk)\n\n## Introduction\n\n`TaikK` is a small utility to tail logs from multiple Kubernetes pods.\n\n## Installation\n\n`TailK` requires Python 3.8+ and `kubectl` available in your shell.\n\n### Using pip\n\n```\n$ pip install tailk\n```\n\n### Using Homebrew\n\n```\n$ brew update\n$ brew tap ffaraone/birre\n$ brew install ffaraone/birre/tailk\n```\n\n\n## Usage\n\n### Basic usage\n\n```\n$ tailk pattern1 [...]\n```\n\nwhere `pattern1` is any valid Python regular expression.\n\n> Multiple patterns are combined with a logical `OR`.\n\n\n### Advanced usage\n\nYou may want to highlight portions of the log. In this case you can provide highlighting patterns in the following way:\n\n```\n$ tailk pattern1 --highlight hl-pattern-1 [--highlight hl-pattern-2]\n```\n\nwhere `hl-pattern-1` is any valid Python regular expression.\n\nYou can also customize the style for highlight. In this case your patterns must be specified using named capturing groups\n\n```\n$ tailk pattern1 --highlight \"(?P<hello>HELLO)\" --style \"hello:underline magenta\"\n```\n\n## License\n\n`TailK` is released under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Tail kubernetes pods logs",
"version": "0.1.0",
"split_keywords": [
"tail",
"log",
"kubernetes",
"pods"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "08b4ebf2a9262d11eb4e816fb0cb43ff82c14e1dfc1391aabccecf30d57e4ae4",
"md5": "5cb1ca1c246c4c42f5809bbc2fa30f08",
"sha256": "74a85367b35d63197f07c011e7c85a586ce9f0b0caee939f84a71a6ec15c8d85"
},
"downloads": -1,
"filename": "tailk-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5cb1ca1c246c4c42f5809bbc2fa30f08",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4",
"size": 9606,
"upload_time": "2023-02-07T21:01:03",
"upload_time_iso_8601": "2023-02-07T21:01:03.580833Z",
"url": "https://files.pythonhosted.org/packages/08/b4/ebf2a9262d11eb4e816fb0cb43ff82c14e1dfc1391aabccecf30d57e4ae4/tailk-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "37710aca16f07c41b90a4211ad52b46e4406f05d128ff20b3006b1e3a87bd1fc",
"md5": "8053281405eda5930c782b0e056cd737",
"sha256": "51bef4417220ab6f31308589a1d237b59e13d144b571bacab9e419f309c7e1cf"
},
"downloads": -1,
"filename": "tailk-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "8053281405eda5930c782b0e056cd737",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4",
"size": 8927,
"upload_time": "2023-02-07T21:01:05",
"upload_time_iso_8601": "2023-02-07T21:01:05.251695Z",
"url": "https://files.pythonhosted.org/packages/37/71/0aca16f07c41b90a4211ad52b46e4406f05d128ff20b3006b1e3a87bd1fc/tailk-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-07 21:01:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ffaraone",
"github_project": "tailk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tailk"
}