| Name | kanban-tui JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | customizeable task tui powered by textual |
| upload_time | 2024-10-19 11:13:07 |
| 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 -->
## 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>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.
## Usage
### Normal Mode
```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.
```bash
ktui demo
```
## 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/57/4a/3e73e4f76938b29ed8dcd01fc0e8491ae30608ad54e282b397373e5e624f/kanban_tui-0.3.1.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 -->\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>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\n\n## Usage\n### Normal Mode\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.\n\n```bash\nktui demo\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.3.1",
"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": "be8048eeda873e1a2526535ab11792358d1702bdef3030e70aa2fd3651853193",
"md5": "b0bd8bbfd2b5fa20478eb1f6e6a9251f",
"sha256": "1442b20bc281e4872ad5da0ddd51b4e043c4f42ecd7ee9a986e5e2fbd45a57d7"
},
"downloads": -1,
"filename": "kanban_tui-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b0bd8bbfd2b5fa20478eb1f6e6a9251f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 38492,
"upload_time": "2024-10-19T11:13:05",
"upload_time_iso_8601": "2024-10-19T11:13:05.391143Z",
"url": "https://files.pythonhosted.org/packages/be/80/48eeda873e1a2526535ab11792358d1702bdef3030e70aa2fd3651853193/kanban_tui-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "574a3e73e4f76938b29ed8dcd01fc0e8491ae30608ad54e282b397373e5e624f",
"md5": "b4e63959b8592c8522e8d810bbb99981",
"sha256": "59bb7eb1b0428ef552857ae38fa0fdad0b6dba1d3846bc527368a285e18ae811"
},
"downloads": -1,
"filename": "kanban_tui-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "b4e63959b8592c8522e8d810bbb99981",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 157634,
"upload_time": "2024-10-19T11:13:07",
"upload_time_iso_8601": "2024-10-19T11:13:07.230990Z",
"url": "https://files.pythonhosted.org/packages/57/4a/3e73e4f76938b29ed8dcd01fc0e8491ae30608ad54e282b397373e5e624f/kanban_tui-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-19 11:13:07",
"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"
}
