# Simple Task Tracker CLI
<!-- [](https://www.repostatus.org/#active) -->
[](https://pypi.org/project/simple-task-tracker/)
[](https://github.com/ismailbenhallam/simple-task-tracker/?tab=MIT-1-ov-file)
<!-- 
-->
A command-line interface (CLI) application to keep track of your tasks, their starting time, finishing time and their
durations.
Tasks could be grouped in projects.
## Installation
You can install the package using either `pipx` or `pip`.
> **Note**: It is highly recommended to install this package using [pipx](https://pipx.pypa.io/stable/). It provides
> an isolated environment for installing and managing command-line tools. It also simplifies running CLIs without
> activating a virtual environment.
> [Check out this page](https://pipx.pypa.io/stable/comparisons/) to compare **pip** and **pipx**.
### Using pipx
```shell
pipx install simple-task-tracker
```
### Using pip
```shell
pip install simple-task-tracker
```
## Usage
After the installation, you can run the CLI application with the following command:
```shell
tt help
```
This will display the list of available commands and their descriptions.
### Commands
- `tt active`: (or **"a"**) List all active tasks
- `tt create`: (or **"c"**) Save a new task as ended. The ended time is the time right now, and the starting time is calculated using (now - duration_in_minutes)
- `tt delete`: (or **"d"**) Delete a task
- `tt finish`: (or **"f"**) Mark a task as done. It can be restarted again using 'start' command. If no task is specified, stop the only active task.
- `tt help` : (or **"h"**) Show help message
- `tt log` : (or **"l"**) Log all tasks of the day
- `tt pause` : (or **"p"**) Pause the active task
- `tt resume`: (or **"r"**) Resume last stopped task
- `tt start` : (or **"s"**) Start a task
- `tt week` : (or **"w"**) Log the current week stats about all project
## Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a
pull request on the [GitHub repository](https://github.com/ismailbenhallam/simple-task-tracker/).
## License
This project is licensed under
the [MIT License](https://github.com/ismailbenhallam/simple-task-tracker/?tab=MIT-1-ov-file).
## Contact
If you have any questions or suggestions, feel free to contact me
at [ismailben44@gmail.com](mailto:ismailben44@gmail.com).
Raw data
{
"_id": null,
"home_page": "https://github.com/ismailbenhallam/simple-task-tracker/",
"name": "simple-task-tracker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "track, task, time",
"author": "Ismail BENHALLAM",
"author_email": "ismailben44@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/56/fb/831bf773aeb19351ba136a8ba910ee2f388127847bdd2ba9001534a394d2/simple_task_tracker-0.1.1.tar.gz",
"platform": null,
"description": "# Simple Task Tracker CLI\n\n<!-- [](https://www.repostatus.org/#active) -->\n[](https://pypi.org/project/simple-task-tracker/)\n\n[](https://github.com/ismailbenhallam/simple-task-tracker/?tab=MIT-1-ov-file)\n\n<!-- \n-->\n\nA command-line interface (CLI) application to keep track of your tasks, their starting time, finishing time and their\ndurations.\nTasks could be grouped in projects.\n\n## Installation\n\nYou can install the package using either `pipx` or `pip`.\n\n> **Note**: It is highly recommended to install this package using [pipx](https://pipx.pypa.io/stable/). It provides\n> an isolated environment for installing and managing command-line tools. It also simplifies running CLIs without\n> activating a virtual environment. \n> [Check out this page](https://pipx.pypa.io/stable/comparisons/) to compare **pip** and **pipx**.\n\n### Using pipx\n\n```shell\npipx install simple-task-tracker\n```\n\n### Using pip\n\n```shell\npip install simple-task-tracker\n```\n\n## Usage\n\nAfter the installation, you can run the CLI application with the following command:\n\n```shell\ntt help\n```\n\nThis will display the list of available commands and their descriptions.\n\n### Commands\n\n- `tt active`: (or **\"a\"**) List all active tasks\n- `tt create`: (or **\"c\"**) Save a new task as ended. The ended time is the time right now, and the starting time is calculated using (now - duration_in_minutes)\n- `tt delete`: (or **\"d\"**) Delete a task\n- `tt finish`: (or **\"f\"**) Mark a task as done. It can be restarted again using 'start' command. If no task is specified, stop the only active task.\n- `tt help` : (or **\"h\"**) Show help message\n- `tt log` : (or **\"l\"**) Log all tasks of the day\n- `tt pause` : (or **\"p\"**) Pause the active task\n- `tt resume`: (or **\"r\"**) Resume last stopped task\n- `tt start` : (or **\"s\"**) Start a task\n- `tt week` : (or **\"w\"**) Log the current week stats about all project\n\n## Contributing\n\nContributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a\npull request on the [GitHub repository](https://github.com/ismailbenhallam/simple-task-tracker/).\n\n## License\n\nThis project is licensed under\nthe [MIT License](https://github.com/ismailbenhallam/simple-task-tracker/?tab=MIT-1-ov-file).\n\n## Contact\n\nIf you have any questions or suggestions, feel free to contact me\nat [ismailben44@gmail.com](mailto:ismailben44@gmail.com).\n",
"bugtrack_url": null,
"license": null,
"summary": "Simple Task Tracker CLI",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/ismailbenhallam/simple-task-tracker/"
},
"split_keywords": [
"track",
" task",
" time"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d9f86da81766fe1d0a4590563f5a83777b9f165c6e7b72a9c14377bd9fad6da",
"md5": "622364357a96d93470c275242eacbc7d",
"sha256": "249ef24c478f8336984b787158767889461d25da4aac9b4cc05d699bea7a169c"
},
"downloads": -1,
"filename": "simple_task_tracker-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "622364357a96d93470c275242eacbc7d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 7074,
"upload_time": "2024-08-28T21:59:38",
"upload_time_iso_8601": "2024-08-28T21:59:38.556840Z",
"url": "https://files.pythonhosted.org/packages/9d/9f/86da81766fe1d0a4590563f5a83777b9f165c6e7b72a9c14377bd9fad6da/simple_task_tracker-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "56fb831bf773aeb19351ba136a8ba910ee2f388127847bdd2ba9001534a394d2",
"md5": "d53225e86fbf4c91b962db5fa36983b2",
"sha256": "58ae63774a808720d9eb3bf9bc00c8c6d0eaab60d7dbf178cb97b8cc3a04b274"
},
"downloads": -1,
"filename": "simple_task_tracker-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "d53225e86fbf4c91b962db5fa36983b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 7418,
"upload_time": "2024-08-28T21:59:39",
"upload_time_iso_8601": "2024-08-28T21:59:39.824655Z",
"url": "https://files.pythonhosted.org/packages/56/fb/831bf773aeb19351ba136a8ba910ee2f388127847bdd2ba9001534a394d2/simple_task_tracker-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-28 21:59:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ismailbenhallam",
"github_project": "simple-task-tracker",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "simple-task-tracker"
}
JSON
