| Name | kanban-tui JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | None |
| Summary | customizeable task tui powered by textual |
| upload_time | 2025-01-04 18:28:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
kanban
python
textual
tui
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!-- Icons -->
[](https://github.com/astral-sh/ruff)
[](https://pypi.org/project/kanban-tui/)
[](https://pypi.python.org/pypi/kanban-tui)
[](https://opensource.org/licenses/MIT)
[](https://pepy.tech/project/kanban-tui)
[](https://coveralls.io/github/Zaloog/kanban-tui?branch=main)
# kanban-tui
kanban-tui is a customizable task manager in the terminal.
<!--  -->
## Demo GIF
If you want to test `kanban-tui` you can directly run this demo yourself with the help of [uv] using `uvx` with
```bash
uvx --from kanban-tui ktui demo
```
## Features
Expand for more detailed information
</details>
<details><summary>Following the XDG basedir convention</summary>
kanban-tui utilizes [platformdirs] `user_config_dir` to save
the config file and `user_data_dir` for the sqlite database.
</details>
</details>
<details><summary>Customizeable Board</summary>
kanban-tui comes with four default columns
(`Ready`, `Doing`, `Done`, `Archive`) but can be customized to your needs.
More columns can be created via the `Settings`-Tab. Also the visibility of columns can be toggled.
Deletion of existing columns is only possible, if no task is present in the column you want to delete.
</details>
</details>
<details><summary>Multi Board Support</summary>
With version v0.4.0 kanban-tui allows the creation of multiple boards.
Use `B` on the `Kanban Board`-Tab to get an overview over all Boards including
the amount of columns, tasks and the closest Due Date.
Each Board starts with the default columns, but the columns are individual for each board.
</details>
</details>
<details><summary>Task Management</summary>
When on the `Kanban Board`-Tab you can `create (n)`, `edit (e)`, `delete (d)` or `move (H, L)` tasks between columns.
</details>
<!-- </details>
<details><summary>Database Infomation</summary>
- Task attributes
- Title
- Category
- Description
- Due Date
- Creation Date (updated on task creation)
- Start Date (updated on movement to Doing column)
- Finish Date (updated on movement to Done column)
</details> -->
</details>
<details><summary>Visual Summary</summary>
To give you an overview over the amount of tasks you `created`, `started` or `finished`, kanban-tui
provides an `Overview`-Tab to show you a bar-chart on a `monthly`, `weekly` or `daily` scale.
It also can be changed to a stacked bar chart per category.
This feature is powered by the [plotext] library with help of [textual-plotext].
</details>
## Installation
You can install `kanban-tui` with one of the following options:
```bash
# not recommended
pip install kanban-tui
```
```bash
pipx install kanban-tui
```
```bash
rye install kanban-tui
```
```bash
uv tool install kanban-tui
```
I recommend using [pipx], [rye] or [uv] to install CLI Tools into an isolated environment.
To be able to use `kanban-tui` in your browser with the `--web`-flag, the optional dependency
`textual-serve` is needed. You can add this to `kanban-tui` by installing the optional `web`-dependency
with the installer of your choice, for example with [uv]:
```bash
uv tool install kanban-tui[web]
```
## Usage
### Normal Mode
Starts `kanban-tui` with a starting board. The application can be closed by pressing `ctrl+q`.
Pass the `--web` flag and follow the shown link to open `kanban-tui` in your browser.
```bash
ktui
```
### Demo Mode
Creates a temporary Config and Database which is populated with example Tasks to play around.
Kanban-Tui will delete the temporary Config and Database after closing the application.
Pass the `--clean` flag to start with an empty demo app.
Pass the `--keep` flag to tell `kanban-tui` not to delete the temporary Database and Config.
Pass the `--web` flag and follow the shown link to open `kanban-tui` in your browser.
```bash
ktui demo
```
### Clear Database and Configuration
If you want to start with a fresh database and configuration file, you can use this command to
delete your current database and configuration file.
```bash
ktui clear
```
## Feedback and Issues
Feel free to reach out and share your feedback, or open an [Issue],
if something doesnt work as expected.
Also check the [Changelog] for new updates.
<!-- Repo Links -->
[Changelog]: https://github.com/Zaloog/kanban-tui/blob/main/CHANGELOG.md
[Issue]: https://github.com/Zaloog/kanban-tui/issues
<!-- external Links Python -->
[platformdirs]: https://platformdirs.readthedocs.io/en/latest/
[textual]: https://textual.textualize.io
[pipx]: https://github.com/pypa/pipx
[PyPi]: https://pypi.org/project/kanban-tui/
[plotext]: https://github.com/piccolomo/plotext
[textual-plotext]: https://github.com/Textualize/textual-plotext
<!-- external Links Others -->
[XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
[rye]: https://rye.astral.sh
[uv]: https://docs.astral.sh/uv
Raw data
{
"_id": null,
"home_page": null,
"name": "kanban-tui",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "kanban, python, textual, tui",
"author": null,
"author_email": "Zaloog <gramslars@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f2/55/d0029a40609b5142f93c93b0195ee64d592599079b2a8de3574ab4af180c/kanban_tui-0.6.0.tar.gz",
"platform": null,
"description": "<!-- Icons -->\n[](https://github.com/astral-sh/ruff)\n[](https://pypi.org/project/kanban-tui/)\n[](https://pypi.python.org/pypi/kanban-tui)\n[](https://opensource.org/licenses/MIT)\n[](https://pepy.tech/project/kanban-tui)\n[](https://coveralls.io/github/Zaloog/kanban-tui?branch=main)\n\n# kanban-tui\n\nkanban-tui is a customizable task manager in the terminal.\n\n<!--  -->\n\n## Demo GIF\n\n\nIf you want to test `kanban-tui` you can directly run this demo yourself with the help of [uv] using `uvx` with\n\n```bash\nuvx --from kanban-tui ktui demo\n```\n\n## Features\nExpand for more detailed information\n\n</details>\n<details><summary>Following the XDG basedir convention</summary>\n\nkanban-tui utilizes [platformdirs] `user_config_dir` to save\nthe config file and `user_data_dir` for the sqlite database.\n</details>\n\n</details>\n<details><summary>Customizeable Board</summary>\n\nkanban-tui comes with four default columns\n(`Ready`, `Doing`, `Done`, `Archive`) but can be customized to your needs.\nMore columns can be created via the `Settings`-Tab. Also the visibility of columns can be toggled.\nDeletion of existing columns is only possible, if no task is present in the column you want to delete.\n</details>\n\n</details>\n<details><summary>Multi Board Support</summary>\n\nWith version v0.4.0 kanban-tui allows the creation of multiple boards.\nUse `B` on the `Kanban Board`-Tab to get an overview over all Boards including\nthe amount of columns, tasks and the closest Due Date.\nEach Board starts with the default columns, but the columns are individual for each board.\n</details>\n\n</details>\n<details><summary>Task Management</summary>\n\nWhen on the `Kanban Board`-Tab you can `create (n)`, `edit (e)`, `delete (d)` or `move (H, L)` tasks between columns.\n</details>\n\n<!-- </details>\n<details><summary>Database Infomation</summary>\n\n- Task attributes\n - Title\n - Category\n - Description\n - Due Date\n - Creation Date (updated on task creation)\n - Start Date (updated on movement to Doing column)\n - Finish Date (updated on movement to Done column)\n</details> -->\n\n</details>\n<details><summary>Visual Summary</summary>\n\nTo give you an overview over the amount of tasks you `created`, `started` or `finished`, kanban-tui\nprovides an `Overview`-Tab to show you a bar-chart on a `monthly`, `weekly` or `daily` scale.\nIt also can be changed to a stacked bar chart per category.\nThis feature is powered by the [plotext] library with help of [textual-plotext].\n</details>\n\n## Installation\n\nYou can install `kanban-tui` with one of the following options:\n\n```bash\n# not recommended\npip install kanban-tui\n```\n\n```bash\npipx install kanban-tui\n```\n\n```bash\nrye install kanban-tui\n```\n\n```bash\nuv tool install kanban-tui\n```\nI recommend using [pipx], [rye] or [uv] to install CLI Tools into an isolated environment.\n\nTo be able to use `kanban-tui` in your browser with the `--web`-flag, the optional dependency\n`textual-serve` is needed. You can add this to `kanban-tui` by installing the optional `web`-dependency\nwith the installer of your choice, for example with [uv]:\n\n```bash\nuv tool install kanban-tui[web]\n```\n\n\n## Usage\n### Normal Mode\nStarts `kanban-tui` with a starting board. The application can be closed by pressing `ctrl+q`.\nPass the `--web` flag and follow the shown link to open `kanban-tui` in your browser.\n```bash\nktui\n```\n\n### Demo Mode\nCreates a temporary Config and Database which is populated with example Tasks to play around.\nKanban-Tui will delete the temporary Config and Database after closing the application.\nPass the `--clean` flag to start with an empty demo app.\nPass the `--keep` flag to tell `kanban-tui` not to delete the temporary Database and Config.\nPass the `--web` flag and follow the shown link to open `kanban-tui` in your browser.\n\n```bash\nktui demo\n```\n\n### Clear Database and Configuration\nIf you want to start with a fresh database and configuration file, you can use this command to\ndelete your current database and configuration file.\n\n```bash\nktui clear\n```\n\n## Feedback and Issues\nFeel free to reach out and share your feedback, or open an [Issue],\nif something doesnt work as expected.\nAlso check the [Changelog] for new updates.\n\n\n<!-- Repo Links -->\n[Changelog]: https://github.com/Zaloog/kanban-tui/blob/main/CHANGELOG.md\n[Issue]: https://github.com/Zaloog/kanban-tui/issues\n\n\n<!-- external Links Python -->\n[platformdirs]: https://platformdirs.readthedocs.io/en/latest/\n[textual]: https://textual.textualize.io\n[pipx]: https://github.com/pypa/pipx\n[PyPi]: https://pypi.org/project/kanban-tui/\n[plotext]: https://github.com/piccolomo/plotext\n[textual-plotext]: https://github.com/Textualize/textual-plotext\n\n<!-- external Links Others -->\n[XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html\n[rye]: https://rye.astral.sh\n[uv]: https://docs.astral.sh/uv\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "customizeable task tui powered by textual",
"version": "0.6.0",
"project_urls": {
"Changelog": "https://github.com/Zaloog/kanban-tui/blob/main/CHANGELOG.md",
"Repository": "https://github.com/Zaloog/kanban-tui"
},
"split_keywords": [
"kanban",
" python",
" textual",
" tui"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e113f868d5ff29f0cfe1f7d445a83dfa52da9c29ef0e1a839bdbc912de6a74b3",
"md5": "2904470446d3345b1a786f600c80debe",
"sha256": "94d4917a15e6f81b5f749f8f80dd201b4425c478d10a941a442768c5dfb8fd80"
},
"downloads": -1,
"filename": "kanban_tui-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2904470446d3345b1a786f600c80debe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 47056,
"upload_time": "2025-01-04T18:28:23",
"upload_time_iso_8601": "2025-01-04T18:28:23.577274Z",
"url": "https://files.pythonhosted.org/packages/e1/13/f868d5ff29f0cfe1f7d445a83dfa52da9c29ef0e1a839bdbc912de6a74b3/kanban_tui-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f255d0029a40609b5142f93c93b0195ee64d592599079b2a8de3574ab4af180c",
"md5": "c519946f2e257cb715e594000cbf239a",
"sha256": "64501174428afed54391910d4192e0f864dd803dda5a2ad679b13aa34f211eb6"
},
"downloads": -1,
"filename": "kanban_tui-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "c519946f2e257cb715e594000cbf239a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 6243368,
"upload_time": "2025-01-04T18:28:26",
"upload_time_iso_8601": "2025-01-04T18:28:26.000204Z",
"url": "https://files.pythonhosted.org/packages/f2/55/d0029a40609b5142f93c93b0195ee64d592599079b2a8de3574ab4af180c/kanban_tui-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-04 18:28:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Zaloog",
"github_project": "kanban-tui",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kanban-tui"
}
