# checks
A CLI application for managing tasks for your project while coding them. It is specifically designed for programmers, but anyone can use it ofcourse.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/demo.gif" />
</p>
## Installation:
`checks` can easily be installed using `pip` package manager. (make sure python and pip are installed in your machine)
```shell
>> pip install checks-cli
```
To all non-programmers, you have to install [Python](https://www.python.org/downloads/) to use this application. _(well, atleast for now!)_
## Usage:
Run `checks` command in the terminal in your project directory _(or anywhere)_
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/checks.jpg" />
</p>
This will run the checks interactive session, similar to the Python Interactive Shell.
Now you can run commands provided by `checks`. Run `help` or `h` to see available commands.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/help.jpg" />
</p>
Seems a bit messy but it's really not. There are three columns in there. one for full **command**, one for **alias** or a shorter version, one for command **description**.
### Adding Tasks is Database / List:
Tasks can be added into list using `add` or `a` _(if you prefer less keystrokes)_.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/add_feature.jpg" />
</p>
When run for the first time, it adds a `tasks.json` in current directory and stores the task in it. After that, whenever you run `checks` in that directory and if that `tasks.json` is still there, it automatically loads that file and continues from there.
You can also add multiple tasks in one go.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/add_multiple_tasks.jpg" />
</p>
### Listing Tasks:
Now that we've added some tasks in our database, let's take a look at them using `list` or `ls` command.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/ls.jpg" />
</p>
`ls` alone, shows all tasks and their details. for a more minimal table, use the flag `-m` or `--minimal` followed by `ls`.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/ls_minimal.jpg" />
</p>
Minimal version just shows the `task` and it's `ID`. This is particularly useful in situations where you task spans multiple lines.
Apart from `-m` flag, `ls` has two more commands. `-c` or `--completed` _(which lists only completed tasks)_ and `-p` or `--pending` _(which lists only pending tasks)_.
### Checking Tasks:
You can check a task _(mark it as complete)_ using `check` or `c` command followed by Task `ID`.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/check_task.jpg" />
</p>
You can check multiple tasks at once.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/check_multiple_tasks.jpg" />
</p>
You can also use `-a` or `--all` flag which checks all pending tasks and shows how many tasks were checked.
Let's `list` the tasks now.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/check_ls.jpg" />
</p>
### Unchecking Tasks:
You can use `uncheck` or `uc` command to uncheck a task _(mark it as incomplete/pending)_.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/uncheck_task.jpg" />
</p>
Or uncheck multiple tasks.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/uncheck_multiple_tasks.jpg" />
</p>
Or uncheck all tasks.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/uncheck_all.jpg" />
</p>
Listing all tasks now.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/uncheck_ls.jpg" />
</p>
### Removing Tasks:
You can remove tasks using `remove` or `rm` command.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/rm_task.jpg" />
</p>
Or remove multiple tasks.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/rm_multiple_tasks.jpg" />
</p>
Or remove all tasks at once using `-a` or `--all` flag, following `rm`.
### Searching Tasks:
Use `search` or `s` command to search for tasks using a query/keyword. (I've added some task in database)
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/search_ls.jpg" />
</p>
Let's `search` for a tasks that contain the word **feature**.
<p align="center">
<img src="https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/search_feature.jpg" />
</p>
### Clearing Terminal:
By now your terminal must have been looking really messy with all the commands and outputs and the TEXT!! Well, you can clear the terminal using `clear` or `cls` command.
```shell
@checks/> clear
```
This will clear entire terminal session. Very handy!
### Saving Database:
Although `checks` saves your tasks after each successfull command execution, you can save the database manually just to be on the safe side. Use `save` or `sv` to save/write every task from in-memory database to `tasks.json`.
```shell
@checks/> save
█ Info: Database saved.
```
### Exiting Application:
Finally, Use `quit` or `q` command to quit the `checks` session.
```shell
@checks/> quit
```
Or just hit `CTRL+C` to force quit the session.
That's it. Now you know more `checks` than me, have fun coding!
Raw data
{
"_id": null,
"home_page": "https://github.com/anas-shakeel/checks",
"name": "checks-cli",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "todo, task, task-manager, tasklist, todo-list, cli, command-line, productivity, organizer",
"author": "Anas Shakeel",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/0f/48/685bc4c36b7644da6afe81cd2ddfc4b31ea0c20ea386325b89e43f551430/checks_cli-1.1.0.tar.gz",
"platform": null,
"description": "# checks\r\n\r\nA CLI application for managing tasks for your project while coding them. It is specifically designed for programmers, but anyone can use it ofcourse.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/demo.gif\" />\r\n</p>\r\n\r\n## Installation:\r\n\r\n`checks` can easily be installed using `pip` package manager. (make sure python and pip are installed in your machine)\r\n\r\n```shell\r\n>> pip install checks-cli\r\n```\r\n\r\nTo all non-programmers, you have to install [Python](https://www.python.org/downloads/) to use this application. _(well, atleast for now!)_\r\n\r\n## Usage:\r\n\r\nRun `checks` command in the terminal in your project directory _(or anywhere)_\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/checks.jpg\" />\r\n</p>\r\n\r\nThis will run the checks interactive session, similar to the Python Interactive Shell.\r\n\r\nNow you can run commands provided by `checks`. Run `help` or `h` to see available commands.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/help.jpg\" />\r\n</p>\r\n\r\nSeems a bit messy but it's really not. There are three columns in there. one for full **command**, one for **alias** or a shorter version, one for command **description**.\r\n\r\n### Adding Tasks is Database / List:\r\n\r\nTasks can be added into list using `add` or `a` _(if you prefer less keystrokes)_.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/add_feature.jpg\" />\r\n</p>\r\n\r\nWhen run for the first time, it adds a `tasks.json` in current directory and stores the task in it. After that, whenever you run `checks` in that directory and if that `tasks.json` is still there, it automatically loads that file and continues from there.\r\n\r\nYou can also add multiple tasks in one go.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/add_multiple_tasks.jpg\" />\r\n</p>\r\n\r\n### Listing Tasks:\r\n\r\nNow that we've added some tasks in our database, let's take a look at them using `list` or `ls` command.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/ls.jpg\" />\r\n</p>\r\n\r\n`ls` alone, shows all tasks and their details. for a more minimal table, use the flag `-m` or `--minimal` followed by `ls`.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/ls_minimal.jpg\" />\r\n</p>\r\n\r\nMinimal version just shows the `task` and it's `ID`. This is particularly useful in situations where you task spans multiple lines.\r\n\r\nApart from `-m` flag, `ls` has two more commands. `-c` or `--completed` _(which lists only completed tasks)_ and `-p` or `--pending` _(which lists only pending tasks)_.\r\n\r\n### Checking Tasks:\r\n\r\nYou can check a task _(mark it as complete)_ using `check` or `c` command followed by Task `ID`.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/check_task.jpg\" />\r\n</p>\r\n\r\nYou can check multiple tasks at once.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/check_multiple_tasks.jpg\" />\r\n</p>\r\n\r\nYou can also use `-a` or `--all` flag which checks all pending tasks and shows how many tasks were checked.\r\n\r\nLet's `list` the tasks now.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/check_ls.jpg\" />\r\n</p>\r\n\r\n### Unchecking Tasks:\r\n\r\nYou can use `uncheck` or `uc` command to uncheck a task _(mark it as incomplete/pending)_.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/uncheck_task.jpg\" />\r\n</p>\r\n\r\nOr uncheck multiple tasks.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/uncheck_multiple_tasks.jpg\" />\r\n</p>\r\n\r\nOr uncheck all tasks.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/uncheck_all.jpg\" />\r\n</p>\r\n\r\nListing all tasks now.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/uncheck_ls.jpg\" />\r\n</p>\r\n\r\n### Removing Tasks:\r\n\r\nYou can remove tasks using `remove` or `rm` command.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/rm_task.jpg\" />\r\n</p>\r\n\r\nOr remove multiple tasks.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/rm_multiple_tasks.jpg\" />\r\n</p>\r\n\r\nOr remove all tasks at once using `-a` or `--all` flag, following `rm`.\r\n\r\n### Searching Tasks:\r\n\r\nUse `search` or `s` command to search for tasks using a query/keyword. (I've added some task in database)\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/search_ls.jpg\" />\r\n</p>\r\n\r\nLet's `search` for a tasks that contain the word **feature**.\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/Anas-Shakeel/checks/main/assets/search_feature.jpg\" />\r\n</p>\r\n\r\n### Clearing Terminal:\r\n\r\nBy now your terminal must have been looking really messy with all the commands and outputs and the TEXT!! Well, you can clear the terminal using `clear` or `cls` command.\r\n\r\n```shell\r\n@checks/> clear\r\n```\r\n\r\nThis will clear entire terminal session. Very handy!\r\n\r\n### Saving Database:\r\n\r\nAlthough `checks` saves your tasks after each successfull command execution, you can save the database manually just to be on the safe side. Use `save` or `sv` to save/write every task from in-memory database to `tasks.json`.\r\n\r\n```shell\r\n@checks/> save\r\n\u2588 Info: Database saved.\r\n```\r\n\r\n### Exiting Application:\r\n\r\nFinally, Use `quit` or `q` command to quit the `checks` session.\r\n\r\n```shell\r\n@checks/> quit\r\n```\r\n\r\nOr just hit `CTRL+C` to force quit the session.\r\n\r\nThat's it. Now you know more `checks` than me, have fun coding!\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Command-line tool to manage tasks list.",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/anas-shakeel/checks"
},
"split_keywords": [
"todo",
" task",
" task-manager",
" tasklist",
" todo-list",
" cli",
" command-line",
" productivity",
" organizer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cc0e006a630682e8efb5da124cfeedd76e6fe4b907d2cdfa9e082b4fea41c865",
"md5": "dbfab23ec90c227a250b57cd72af3832",
"sha256": "b2916743a3ce07369711cfe3d78bb7f7e86ea9a4e7cea53b7b329dade77ef332"
},
"downloads": -1,
"filename": "checks_cli-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dbfab23ec90c227a250b57cd72af3832",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12363,
"upload_time": "2024-11-18T16:25:08",
"upload_time_iso_8601": "2024-11-18T16:25:08.102306Z",
"url": "https://files.pythonhosted.org/packages/cc/0e/006a630682e8efb5da124cfeedd76e6fe4b907d2cdfa9e082b4fea41c865/checks_cli-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f48685bc4c36b7644da6afe81cd2ddfc4b31ea0c20ea386325b89e43f551430",
"md5": "0a0ead1f17b85454b43b472a05295966",
"sha256": "fc3cf1ac5d20aa9e3e2a13207146360a7ff9a7e071ed2cbdcf9bc028ec100728"
},
"downloads": -1,
"filename": "checks_cli-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0a0ead1f17b85454b43b472a05295966",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12724,
"upload_time": "2024-11-18T16:25:09",
"upload_time_iso_8601": "2024-11-18T16:25:09.224568Z",
"url": "https://files.pythonhosted.org/packages/0f/48/685bc4c36b7644da6afe81cd2ddfc4b31ea0c20ea386325b89e43f551430/checks_cli-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 16:25:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "anas-shakeel",
"github_project": "checks",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "checks-cli"
}
JSON
