simple-task-tracker


Namesimple-task-tracker JSON
Version 2.4.1 PyPI version JSON
download
home_pagehttps://github.com/ismailbenhallam/simple-task-tracker/
SummarySimple Task Tracker CLI
upload_time2025-04-25 17:14:15
maintainerNone
docs_urlNone
authorIsmail BENHALLAM
requires_python>=3.11
licenseNone
keywords track task time
VCS
bugtrack_url
requirements typer
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Simple Task Tracker CLI

<!-- [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) -->
[![PyPI - Version](https://img.shields.io/pypi/v/simple-task-tracker?style=for-the-badge)](https://pypi.org/project/simple-task-tracker/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/simple-task-tracker?style=for-the-badge)
[![GitHub License](https://img.shields.io/github/license/ismailbenhallam/simple-task-tracker?style=for-the-badge)](https://github.com/ismailbenhallam/simple-task-tracker/?tab=MIT-1-ov-file)

<!-- ![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/ismailbenhallam/simple-task-tracker)
![GitHub Repo stars](https://img.shields.io/github/stars/ismailbenhallam/simple-task-tracker?)-->

A command-line interface (CLI) application to keep track of your tasks, their starting time, finishing time and their
durations. The CLI uses a SQLite DB to store data.
## 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 grep`  :   (or **"g"**) Search for tasks containing the given pattern (case insensitive). Optionally limit to a specific date.
- `tt help`  :   (or **"h"**) Show help message.
- `tt log`   :   (or **"l"**) Log all tasks of the day **(DD-MM)**. If `--date` is not provided, today's date will be used.
- `tt pause` :   (or **"p"**) Pause the active task.
- `tt resume`:   (or **"r"**) Resume last stopped task.
- `tt start` :   (or **"s"**) Start a task.
- `tt stats` :   Show statistics about your work patterns.
- `tt week`  :   (or **"w"**) List all tasks for the current week along with their durations.

## 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/65/b1/af768ccbd6e84f3990c82210a6324861f4add8a57e0b994deec6ab37ca82/simple_task_tracker-2.4.1.tar.gz",
    "platform": null,
    "description": "# Simple Task Tracker CLI\n\n<!-- [![Project Status: Active \u2013 The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) -->\n[![PyPI - Version](https://img.shields.io/pypi/v/simple-task-tracker?style=for-the-badge)](https://pypi.org/project/simple-task-tracker/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/simple-task-tracker?style=for-the-badge)\n[![GitHub License](https://img.shields.io/github/license/ismailbenhallam/simple-task-tracker?style=for-the-badge)](https://github.com/ismailbenhallam/simple-task-tracker/?tab=MIT-1-ov-file)\n\n<!-- ![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/ismailbenhallam/simple-task-tracker)\n![GitHub Repo stars](https://img.shields.io/github/stars/ismailbenhallam/simple-task-tracker?)-->\n\nA command-line interface (CLI) application to keep track of your tasks, their starting time, finishing time and their\ndurations. The CLI uses a SQLite DB to store data.\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 grep`  :   (or **\"g\"**) Search for tasks containing the given pattern (case insensitive). Optionally limit to a specific date.\n- `tt help`  :   (or **\"h\"**) Show help message.\n- `tt log`   :   (or **\"l\"**) Log all tasks of the day **(DD-MM)**. If `--date` is not provided, today's date will be used.\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 stats` :   Show statistics about your work patterns.\n- `tt week`  :   (or **\"w\"**) List all tasks for the current week along with their durations.\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": "2.4.1",
    "project_urls": {
        "Homepage": "https://github.com/ismailbenhallam/simple-task-tracker/"
    },
    "split_keywords": [
        "track",
        " task",
        " time"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "eb87bf758ccd1c0caa1d7da7201b88c9335c0fb81e8f38e8b48a1867afc77db1",
                "md5": "a3c0beb241600dee80778391a9df75cc",
                "sha256": "b892e08066746e870c87d87c29bf5e391ffc2a170eb357db2f631daa5f22c87f"
            },
            "downloads": -1,
            "filename": "simple_task_tracker-2.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a3c0beb241600dee80778391a9df75cc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 10492,
            "upload_time": "2025-04-25T17:14:14",
            "upload_time_iso_8601": "2025-04-25T17:14:14.591863Z",
            "url": "https://files.pythonhosted.org/packages/eb/87/bf758ccd1c0caa1d7da7201b88c9335c0fb81e8f38e8b48a1867afc77db1/simple_task_tracker-2.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "65b1af768ccbd6e84f3990c82210a6324861f4add8a57e0b994deec6ab37ca82",
                "md5": "f7a6587d96b787c76136ee0196d1c8d1",
                "sha256": "f25d1006e1fbb7bd8006e5c0653bf5445ea8bbc7d9de272701e8f28109990fd3"
            },
            "downloads": -1,
            "filename": "simple_task_tracker-2.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f7a6587d96b787c76136ee0196d1c8d1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 10765,
            "upload_time": "2025-04-25T17:14:15",
            "upload_time_iso_8601": "2025-04-25T17:14:15.667809Z",
            "url": "https://files.pythonhosted.org/packages/65/b1/af768ccbd6e84f3990c82210a6324861f4add8a57e0b994deec6ab37ca82/simple_task_tracker-2.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-04-25 17:14:15",
    "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": [
        {
            "name": "typer",
            "specs": [
                [
                    "==",
                    "0.12.5"
                ]
            ]
        }
    ],
    "lcname": "simple-task-tracker"
}
        
Elapsed time: 1.36352s