| Name | pytask-list JSON |
| Version |
0.0.21
JSON |
| download |
| home_page | None |
| Summary | A awesome To-do List made with python in your terminal |
| upload_time | 2024-03-24 15:09:35 |
| maintainer | None |
| docs_url | None |
| author | Pablo Troli |
| requires_python | None |
| license | MIT License |
| keywords |
todo
list
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Task List App with Typer, Rich and Python
## Introduction
This document describes a task list application developed with Typer and documented in Markdown. Typer is a Python library that makes it easy to create interactive command line interfaces, while Markdown is a lightweight markup language for text formatting.
### Application Features
The application offers the following functionalities:
* **Add tasks:** Add new tasks to the list with name and category.
* **Remove tasks:** Delete tasks from the list by position.
* **Update tasks:** Modify the name or category of a task.
* **Show all tasks:** Display all tasks in a formatted table.
* **Mark tasks as done:** Mark tasks as completed with a visual indicator.
#### Feature options
Install completion for the current shell (bash, fish, zsh and etc...)
$ --install-completion
Show completion for the current shell, to copy it or customize the installation.
$ --show-completion
Show information that can help you and then exit this option
$ --help
### Example of using CLI commands
#### 1. Command Add
Add a new task to the list.
**Arguments:**
`task`: Name of the task.
`category`: Category of the task.
**Example:**
**For use with Python**
$ python pytask_list.py add "Task 1" "category 1"
#### 2. Command Remove
Delete a task from the list by position.
**Arguments:**
`position`: Position (ID) of the task in the list (starting at 1).
**Example:**
**For use with Python**
$ python pytask_list.py remove 1
#### 3. Command Update
Modify the task or category of a task.
**Arguments:**
`position`: Position of the task in the list (starting at 1).
`task`: New name of the task (optional).
`category`: New category of the task (optional).
**Example:**
**For use with Python**
$ python pytask_list.py update 1 "Buy bread, milk and fruits" House
#### 4. Command Show
Display all tasks in a formatted table.
**Example:**
| ID | Task | Category | Completed |
| 1 | Study_sql | Database | Done ✅ |
| 2 | Study_bash | DevOps | Pendent ❌ |
#### 5. Command task-done
Mark a task as completed.
**Arguments:**
`position`: Position of the task in the list (starting at 1).
**Example:**
**For use with Python**
$ python pytask_list.py task_done 1
## License
This project is licensed under the MIT License. This permissive license allows you to freely use, modify, and distribute the code for any purpose, commercial or non-commercial. A copy of the MIT License can be found in the `LICENSE` file within this repository.
## Acknowledgements
I appreciate the contributions of these open-source projects that made this application possible (.i.g Typer, Rich, Python's community). Beacuse encourage you to contribute to this project and help me improve it!
Raw data
{
"_id": null,
"home_page": null,
"name": "pytask-list",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Todo List",
"author": "Pablo Troli",
"author_email": "brawlixo123@gmail.com.br",
"download_url": "https://files.pythonhosted.org/packages/8e/10/7c3d5bf5e471edbe751ed0deaff93fd8d1e67110b3c6d8bd66d172b2941a/pytask_list-0.0.21.tar.gz",
"platform": null,
"description": "# Task List App with Typer, Rich and Python\n\n## Introduction\n\nThis document describes a task list application developed with Typer and documented in Markdown. Typer is a Python library that makes it easy to create interactive command line interfaces, while Markdown is a lightweight markup language for text formatting.\n\n### Application Features\n\nThe application offers the following functionalities:\n\n* **Add tasks:** Add new tasks to the list with name and category.\n* **Remove tasks:** Delete tasks from the list by position.\n* **Update tasks:** Modify the name or category of a task.\n* **Show all tasks:** Display all tasks in a formatted table.\n* **Mark tasks as done:** Mark tasks as completed with a visual indicator.\n\n#### Feature options\n\nInstall completion for the current shell (bash, fish, zsh and etc...)\n\n\t $ --install-completion\n\nShow completion for the current shell, to copy it or customize the installation. \n\t\n\t $ --show-completion\n\t\n\nShow information that can help you and then exit this option\n\t\n\t $ --help\n\t\n\n### Example of using CLI commands\n\n#### 1. Command Add\nAdd a new task to the list.\n\n**Arguments:**\n\n `task`: Name of the task.\n \n `category`: Category of the task.\n\n**Example:**\n\n**For use with Python**\n\t\n\t $ python pytask_list.py add \"Task 1\" \"category 1\"\n\t\n\n#### 2. Command Remove\nDelete a task from the list by position.\n\n**Arguments:**\n\n`position`: Position (ID) of the task in the list (starting at 1).\n\n**Example:**\n\n**For use with Python**\n\t\n\t $ python pytask_list.py remove 1 \n\t\n\n#### 3. Command Update\nModify the task or category of a task.\n\n**Arguments:**\n\n`position`: Position of the task in the list (starting at 1).\n\n`task`: New name of the task (optional).\n\n`category`: New category of the task (optional).\n\n**Example:**\n\n**For use with Python**\n\t\n\t $ python pytask_list.py update 1 \"Buy bread, milk and fruits\" House\n\t\n\n#### 4. Command Show\nDisplay all tasks in a formatted table.\n\n**Example:**\n \n\t| ID | Task | Category | Completed |\n\t| 1 | Study_sql | Database | Done \u2705 |\n\t| 2 | Study_bash | DevOps | Pendent \u274c |\n\n#### 5. Command task-done\nMark a task as completed.\n\n**Arguments:**\n\n`position`: Position of the task in the list (starting at 1).\n\n**Example:**\n\n**For use with Python**\n\t\n\t $ python pytask_list.py task_done 1\n\t\n\n## License\nThis project is licensed under the MIT License. This permissive license allows you to freely use, modify, and distribute the code for any purpose, commercial or non-commercial. A copy of the MIT License can be found in the `LICENSE` file within this repository.\n\n## Acknowledgements\nI appreciate the contributions of these open-source projects that made this application possible (.i.g Typer, Rich, Python's community). Beacuse encourage you to contribute to this project and help me improve it!\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A awesome To-do List made with python in your terminal",
"version": "0.0.21",
"project_urls": null,
"split_keywords": [
"todo",
"list"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fce9865266ecc3ff6315bc2ecf92f6e1ea93d0208c63d98bbfd5b060962ee631",
"md5": "6852c1c7e4ecde6eda901f46a49c36ff",
"sha256": "1f5dd9eed5f5540013ba7395452c5ff91d97fe1e18c9ee365fa49392265f50a5"
},
"downloads": -1,
"filename": "pytask_list-0.0.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6852c1c7e4ecde6eda901f46a49c36ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6004,
"upload_time": "2024-03-24T15:09:33",
"upload_time_iso_8601": "2024-03-24T15:09:33.385922Z",
"url": "https://files.pythonhosted.org/packages/fc/e9/865266ecc3ff6315bc2ecf92f6e1ea93d0208c63d98bbfd5b060962ee631/pytask_list-0.0.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e107c3d5bf5e471edbe751ed0deaff93fd8d1e67110b3c6d8bd66d172b2941a",
"md5": "da566797c245ca5d78eb8ab1bd7bd8ca",
"sha256": "00fa3ace7be5edac35f4038f4163576fa495972820bd42e725373ad2b1ba753c"
},
"downloads": -1,
"filename": "pytask_list-0.0.21.tar.gz",
"has_sig": false,
"md5_digest": "da566797c245ca5d78eb8ab1bd7bd8ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5246,
"upload_time": "2024-03-24T15:09:35",
"upload_time_iso_8601": "2024-03-24T15:09:35.393850Z",
"url": "https://files.pythonhosted.org/packages/8e/10/7c3d5bf5e471edbe751ed0deaff93fd8d1e67110b3c6d8bd66d172b2941a/pytask_list-0.0.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-24 15:09:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pytask-list"
}
