======
tasks3
======
.. image:: https://img.shields.io/pypi/v/tasks3.svg
:target: https://pypi.python.org/pypi/tasks3
.. image:: https://github.com/hXtreme/tasks3/actions/workflows/tox-test.yml/badge.svg
:target: https://github.com/hXtreme/tasks3/actions/workflows/tox-test.yml
.. image:: https://readthedocs.org/projects/tasks3/badge/?version=latest
:target: https://tasks3.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
A commandline tool to create and manage tasks and todos.
Most task management tools are their own applications, so to manage tasks you have to
perform context switching by leaving what you're working on
to go to the task manager application.
``tasks3`` aims to solve that by bringing your tasks to you instead.
Each task is automatically assigned to the directory it was created in
and you can easily retrieve tasks under a directory.
* Free software: GNU General Public License v3
* Documentation: https://tasks3.readthedocs.io.
Features
--------
Help
====
It is easy to explore all capabilities of ``tasks3`` by running ``tasks3 --help``.
Each command also has its own help page which can be accessed by running:
.. code-block:: console
$ tasks3 <command> --help
Create Tasks
============
Easily create tasks from the commandline and delegate them to folders.
Create a task in a specific folder with default settings.
.. code-block:: console
$ tasks3 add --title "Think of a cool name" \
--folder "~/Documents/story" \
--yes
Added Task:
[e1c100] Think of a cool name (⏰⏰ ) (🚨🚨 )
[path: ~/Documents/story]
Create a task in a current folder with custom settings and description.
.. code-block:: console
$ tasks3 add --title "Try new model" \
--urgency 4 --importance 3 \
--description "Try:\n - model with 3 layers.\n - model with 4 layers." \
--yes
Added Task:
[a0a5f4] Try new model (⏰⏰⏰⏰) (🚨🚨🚨 )
Try:
- model with 3 layers.
- model with 4 layers.
Edit Existing Tasks
===================
You can edit existing tasks with the ``tasks3 edit`` command.
For example: You can use ``edit`` to update the urgency of a task.
.. code-block:: console
$ tasks3 edit --urgency 4 e1c100
Updated Task:
[e1c100] Think of a cool name (⏰⏰⏰⏰) (🚨🚨 )
[path: ~/Documents/story]
Search Tasks
============
You can search for tasks using various filters.
You can search for tasks with a specific importance value.
.. code-block:: console
$ tasks3 search --importance 2
[4a14d0] What is right here and now
[f79155] Think of a cool name [path: /home/<user>/Documents/project]
[2ce91b] See home [path: /home]
You can restrict search to a folder and its sub-directories.
.. code-block:: console
$ tasks3 search --folder ~/Documents/project --output-format yaml
title: Think of a Cool name
urgency: 2
importance: 2
tags: null
folder: /home/<user>/Documents/project
You can also search for sub-strings in task title or description.
It is also possible to restrict the search to tasks that have a specific set of tags.
Run ``tasks3 search --help`` to get see a full list off options.
Show Tasks
==========
You can show all tasks under current directory.
.. code-block:: console
$ tasks3 show
[a0a5f4] Try new model (⏰⏰⏰⏰) (🚨🚨🚨 )
Try:
model with 3 layers.
model with 4 layers.
[4a14d0] What is right here and now (⏰⏰ ) (🚨🚨 )
You can also show a particular task by specifying its id.
.. code-block:: console
$ tasks3 show 1d8a9a
[1d8a9a] Give a Title to this Task. (⏰⏰ ) (🚨🚨🚨🚨)
(Hello tasks3)
Task with
multi-line
desc
If you prefer to see the task in a different format, you can use the ``--output-format`` option.
.. code-block:: console
$ tasks3 show --output-format json 1d8a9a
{
"id": "1d8a9a",
"title": "Give a Title to this Task.",
"urgency": 2,
"importance": 4,
"tags": [
"Hello tasks3"
],
"folder": "/home/<user>/Documents/tasks3",
"description": "Task with \nmulti-line \ndesc"
}
Complete Tasks
==============
You can use the ``tasks3 mark <task_id>`` or ``tasks3 edit --done <task_id>`` command to mark a task as completed.
.. code-block:: console
$ tasks3 mark 2e0b84
[2e0b84] A̶d̶d̶i̶n̶g̶ ̶s̶u̶p̶p̶o̶r̶t̶ ̶f̶o̶r̶ ̶t̶a̶s̶k̶ ̶c̶o̶m̶p̶l̶e̶t̶i̶o̶n̶ (⏰⏰ ) (🚨🚨 )
Delete Tasks
============
You can use the ``tasks3 delete <task_id>`` command to delete a task.
.. note:: Deleting is a destructive action, prefer to mark the task as complete to hide it.
.. code-block:: console
$ tasks3 remove --yes 2e0b84
Removed Task: [2e0b84] Adding support for task deletion (⏰⏰ ) (🚨🚨 )
Shell Integration
=================
tasks3 supports shell integration for bash, zsh, and fish; tasks3 will automatically
run ``tasks3 show -o oneline`` when you ``cd`` into a directory to show
the tasks in that directory.
You can setup shell integration by adding the following command to your ``.rc`` file.
.. code-block:: shell
eval "$(tasks3 shell $(basename $SHELL))"
.. note:: Pull requests to support additional shells are greatly appreciated.
Please see Contributing_ page for information on how to contribute.
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Contributing: ./contributing.html
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.9.0: (2025-01-20)
-------------------
* Drop support for python < 3.12
* Update dependencies
0.8.0: (2023-02-22)
-------------------
* Add support to mark tasks as done.
* Update dependencies
0.7.0: (2022-07-30)
-------------------
* Added support to delete a task from the cli.
* Updated dependencies.
0.6.0 (2022-05-16)
------------------
* Added support to edit existing tasks.
* Update dev-requirements.
0.5.1 (2022-05-06)
------------------
* Added shell integration for fish.
0.5.0 (2022-05-06)
------------------
* Added shell integration for zsh and bash.
* Improve the index page.
* Add more info to Contributing page.
0.4.4 (2022-05-03)
------------------
* Improve docs
0.4.3 (2022-05-03)
------------------
* Fix python version in setup.py
0.4.2 (2022-05-03)
------------------
* Upgrade development status to Alpha.
0.4.1 (2022-05-03)
------------------
* Resolve a SNAFU with tags.
0.4.0 (2022-05-03)
------------------
* Add the ability to search for tasks.
* Add json output format for tasks.
* Implement the ``tasks3 task show`` cli endpoint.
* Update docs.
* Add Output format preference to config.
* Make the cli interface easier to use (flatten the task command tree)
0.3.3 (2022-05-02)
------------------
* Switch docs theme to ``sphinx_rtd_theme``.
0.3.2 (2022-05-02)
------------------
* Add workflow to check for package compatability with PyPI.
This should make sure that the issue with v0.3.0 does not occur again.
0.3.1 (2022-05-02)
------------------
* Fix README to render on PyPI.
0.3.0 (2022-05-02)
------------------
* Remove ``tasks3 db init`` cli command.
* Implement ``tasks3 task add`` cli command.
* Implement ``task.yaml``, ``task.short``, ``task.one_line`` methods to display task.
0.2.8 (2022-05-01)
------------------
* Use dataclass to store configuration settings.
* Flatten tasks3.config module into config.py file.
0.2.7 (2022-04-30)
------------------
* Remove usage of deprecated SQLAlchemy api ``db_engine.table_names``.
* Remove deprecated pytest configuration option ``collect_ignore``.
0.2.6 (2022-04-30)
------------------
* Flatten tasks3.db.model module into models.py
* Linting changes
* Minor refactoring
0.2.4 (2022-04-30)
------------------
* Remove pytest from dependency and let tox handle testing.
0.2.3 (2022-04-30)
------------------
* Migrate testing to github-workflow
* Update SQLAlchemy package version.
* Switch deployment workflow to python 3.9
0.2.0 (2022-04-30)
------------------
* Drop support for python<=3.8
0.1.0 (2020-08-17)
------------------
* Implement tasks3.add
* Implement tasks3.edit
* Implement tasks3.remove
0.0.11 (2020-08-04)
-------------------
* Add support for a yaml configuration file.
* Add database to store Tasks, db models and api to interact with db.
* Switch to using requirements.txt for managing dependency and add
back the support for py35.
* Add a bunch of type annotations.
* Update dependency:
* pip to 20.2
* pytest to 6.0.1
* tox to 3.18.1
* coverage to 5.2.1
0.0.9 - 0.0.10 (2020-07-26)
---------------------------
* Fix version numbers and git tags.
0.0.8 (2020-07-26)
------------------
* Implement a CLI for tasks3.
* Add black (formatter).
* Add some basic test-cases.
0.0.2 - 0.0.7 (2020-07-20)
--------------------------
* Move deployment away from Travis to Github workflow.
0.0.1 (2020-07-20)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/hXtreme/tasks3",
"name": "tasks3",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "tasks3",
"author": "Harsh Parekh",
"author_email": "harsh_parekh@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/a1/08/b1ab62550262f58a2e3bc30d1089e28eb31961bc31167e596eca8f5e37e1/tasks3-0.9.0.tar.gz",
"platform": null,
"description": "======\ntasks3\n======\n\n\n.. image:: https://img.shields.io/pypi/v/tasks3.svg\n :target: https://pypi.python.org/pypi/tasks3\n\n.. image:: https://github.com/hXtreme/tasks3/actions/workflows/tox-test.yml/badge.svg\n :target: https://github.com/hXtreme/tasks3/actions/workflows/tox-test.yml\n\n.. image:: https://readthedocs.org/projects/tasks3/badge/?version=latest\n :target: https://tasks3.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n\n\nA commandline tool to create and manage tasks and todos.\n\nMost task management tools are their own applications, so to manage tasks you have to\nperform context switching by leaving what you're working on\nto go to the task manager application.\n\n``tasks3`` aims to solve that by bringing your tasks to you instead.\n\nEach task is automatically assigned to the directory it was created in\nand you can easily retrieve tasks under a directory.\n\n\n* Free software: GNU General Public License v3\n* Documentation: https://tasks3.readthedocs.io.\n\n\nFeatures\n--------\n\nHelp\n====\n\nIt is easy to explore all capabilities of ``tasks3`` by running ``tasks3 --help``.\nEach command also has its own help page which can be accessed by running:\n\n.. code-block:: console\n\n $ tasks3 <command> --help\n\nCreate Tasks\n============\n\nEasily create tasks from the commandline and delegate them to folders.\n\nCreate a task in a specific folder with default settings.\n\n.. code-block:: console\n\n $ tasks3 add --title \"Think of a cool name\" \\\n --folder \"~/Documents/story\" \\\n --yes\n Added Task:\n [e1c100] Think of a cool name (\u23f0\u23f0 ) (\ud83d\udea8\ud83d\udea8 )\n [path: ~/Documents/story]\n\nCreate a task in a current folder with custom settings and description.\n\n.. code-block:: console\n\n $ tasks3 add --title \"Try new model\" \\\n --urgency 4 --importance 3 \\\n --description \"Try:\\n - model with 3 layers.\\n - model with 4 layers.\" \\\n --yes\n Added Task:\n [a0a5f4] Try new model (\u23f0\u23f0\u23f0\u23f0) (\ud83d\udea8\ud83d\udea8\ud83d\udea8 )\n Try:\n - model with 3 layers.\n - model with 4 layers.\n\nEdit Existing Tasks\n===================\n\nYou can edit existing tasks with the ``tasks3 edit`` command.\n\nFor example: You can use ``edit`` to update the urgency of a task.\n\n.. code-block:: console\n\n $ tasks3 edit --urgency 4 e1c100\n Updated Task:\n [e1c100] Think of a cool name (\u23f0\u23f0\u23f0\u23f0) (\ud83d\udea8\ud83d\udea8 )\n [path: ~/Documents/story]\n\nSearch Tasks\n============\n\nYou can search for tasks using various filters.\n\nYou can search for tasks with a specific importance value.\n\n.. code-block:: console\n\n $ tasks3 search --importance 2\n [4a14d0] What is right here and now\n [f79155] Think of a cool name [path: /home/<user>/Documents/project]\n [2ce91b] See home [path: /home]\n\nYou can restrict search to a folder and its sub-directories.\n\n.. code-block:: console\n\n $ tasks3 search --folder ~/Documents/project --output-format yaml\n title: Think of a Cool name\n urgency: 2\n importance: 2\n tags: null\n folder: /home/<user>/Documents/project\n\nYou can also search for sub-strings in task title or description.\nIt is also possible to restrict the search to tasks that have a specific set of tags.\nRun ``tasks3 search --help`` to get see a full list off options.\n\nShow Tasks\n==========\n\nYou can show all tasks under current directory.\n\n.. code-block:: console\n\n $ tasks3 show\n [a0a5f4] Try new model (\u23f0\u23f0\u23f0\u23f0) (\ud83d\udea8\ud83d\udea8\ud83d\udea8 )\n Try:\n model with 3 layers.\n model with 4 layers.\n [4a14d0] What is right here and now (\u23f0\u23f0 ) (\ud83d\udea8\ud83d\udea8 )\n\nYou can also show a particular task by specifying its id.\n\n.. code-block:: console\n\n $ tasks3 show 1d8a9a\n [1d8a9a] Give a Title to this Task. (\u23f0\u23f0 ) (\ud83d\udea8\ud83d\udea8\ud83d\udea8\ud83d\udea8)\n (Hello tasks3)\n Task with\n multi-line\n desc\n\nIf you prefer to see the task in a different format, you can use the ``--output-format`` option.\n\n.. code-block:: console\n\n $ tasks3 show --output-format json 1d8a9a\n {\n \"id\": \"1d8a9a\",\n \"title\": \"Give a Title to this Task.\",\n \"urgency\": 2,\n \"importance\": 4,\n \"tags\": [\n \"Hello tasks3\"\n ],\n \"folder\": \"/home/<user>/Documents/tasks3\",\n \"description\": \"Task with \\nmulti-line \\ndesc\"\n }\n\n\nComplete Tasks\n==============\n\nYou can use the ``tasks3 mark <task_id>`` or ``tasks3 edit --done <task_id>`` command to mark a task as completed.\n\n.. code-block:: console\n\n $ tasks3 mark 2e0b84\n [2e0b84] A\u0336d\u0336d\u0336i\u0336n\u0336g\u0336 \u0336s\u0336u\u0336p\u0336p\u0336o\u0336r\u0336t\u0336 \u0336f\u0336o\u0336r\u0336 \u0336t\u0336a\u0336s\u0336k\u0336 \u0336c\u0336o\u0336m\u0336p\u0336l\u0336e\u0336t\u0336i\u0336o\u0336n\u0336 (\u23f0\u23f0 ) (\ud83d\udea8\ud83d\udea8 )\n\n\nDelete Tasks\n============\n\nYou can use the ``tasks3 delete <task_id>`` command to delete a task.\n\n.. note:: Deleting is a destructive action, prefer to mark the task as complete to hide it.\n\n.. code-block:: console\n\n $ tasks3 remove --yes 2e0b84\n Removed Task: [2e0b84] Adding support for task deletion (\u23f0\u23f0 ) (\ud83d\udea8\ud83d\udea8 )\n\nShell Integration\n=================\n\ntasks3 supports shell integration for bash, zsh, and fish; tasks3 will automatically\nrun ``tasks3 show -o oneline`` when you ``cd`` into a directory to show\nthe tasks in that directory.\n\nYou can setup shell integration by adding the following command to your ``.rc`` file.\n\n.. code-block:: shell\n\n eval \"$(tasks3 shell $(basename $SHELL))\"\n\n.. note:: Pull requests to support additional shells are greatly appreciated.\n Please see Contributing_ page for information on how to contribute.\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Contributing: ./contributing.html\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n0.9.0: (2025-01-20)\n-------------------\n\n* Drop support for python < 3.12\n* Update dependencies\n\n0.8.0: (2023-02-22)\n-------------------\n\n* Add support to mark tasks as done.\n* Update dependencies\n\n0.7.0: (2022-07-30)\n-------------------\n\n* Added support to delete a task from the cli.\n* Updated dependencies.\n\n0.6.0 (2022-05-16)\n------------------\n\n* Added support to edit existing tasks.\n* Update dev-requirements.\n\n0.5.1 (2022-05-06)\n------------------\n\n* Added shell integration for fish.\n\n0.5.0 (2022-05-06)\n------------------\n\n* Added shell integration for zsh and bash.\n* Improve the index page.\n* Add more info to Contributing page.\n\n0.4.4 (2022-05-03)\n------------------\n\n* Improve docs\n\n0.4.3 (2022-05-03)\n------------------\n\n* Fix python version in setup.py\n\n0.4.2 (2022-05-03)\n------------------\n\n* Upgrade development status to Alpha.\n\n0.4.1 (2022-05-03)\n------------------\n\n* Resolve a SNAFU with tags.\n\n0.4.0 (2022-05-03)\n------------------\n\n* Add the ability to search for tasks.\n* Add json output format for tasks.\n* Implement the ``tasks3 task show`` cli endpoint.\n* Update docs.\n* Add Output format preference to config.\n* Make the cli interface easier to use (flatten the task command tree)\n\n0.3.3 (2022-05-02)\n------------------\n\n* Switch docs theme to ``sphinx_rtd_theme``.\n\n0.3.2 (2022-05-02)\n------------------\n\n* Add workflow to check for package compatability with PyPI.\n This should make sure that the issue with v0.3.0 does not occur again.\n\n0.3.1 (2022-05-02)\n------------------\n\n* Fix README to render on PyPI.\n\n0.3.0 (2022-05-02)\n------------------\n\n* Remove ``tasks3 db init`` cli command.\n* Implement ``tasks3 task add`` cli command.\n* Implement ``task.yaml``, ``task.short``, ``task.one_line`` methods to display task.\n\n0.2.8 (2022-05-01)\n------------------\n\n* Use dataclass to store configuration settings.\n* Flatten tasks3.config module into config.py file.\n\n0.2.7 (2022-04-30)\n------------------\n\n* Remove usage of deprecated SQLAlchemy api ``db_engine.table_names``.\n* Remove deprecated pytest configuration option ``collect_ignore``.\n\n0.2.6 (2022-04-30)\n------------------\n\n* Flatten tasks3.db.model module into models.py\n* Linting changes\n* Minor refactoring\n\n0.2.4 (2022-04-30)\n------------------\n\n* Remove pytest from dependency and let tox handle testing.\n\n0.2.3 (2022-04-30)\n------------------\n\n* Migrate testing to github-workflow\n* Update SQLAlchemy package version.\n* Switch deployment workflow to python 3.9\n\n0.2.0 (2022-04-30)\n------------------\n\n* Drop support for python<=3.8\n\n0.1.0 (2020-08-17)\n------------------\n\n* Implement tasks3.add\n* Implement tasks3.edit\n* Implement tasks3.remove\n\n0.0.11 (2020-08-04)\n-------------------\n\n* Add support for a yaml configuration file.\n* Add database to store Tasks, db models and api to interact with db.\n* Switch to using requirements.txt for managing dependency and add\n back the support for py35.\n* Add a bunch of type annotations.\n* Update dependency:\n * pip to 20.2\n * pytest to 6.0.1\n * tox to 3.18.1\n * coverage to 5.2.1\n\n0.0.9 - 0.0.10 (2020-07-26)\n---------------------------\n\n* Fix version numbers and git tags.\n\n0.0.8 (2020-07-26)\n------------------\n\n* Implement a CLI for tasks3.\n* Add black (formatter).\n* Add some basic test-cases.\n\n0.0.2 - 0.0.7 (2020-07-20)\n--------------------------\n\n* Move deployment away from Travis to Github workflow.\n\n0.0.1 (2020-07-20)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "GNU General Public License v3",
"summary": "A commandline tool to create and manage tasks and todos.",
"version": "0.9.0",
"project_urls": {
"Homepage": "https://github.com/hXtreme/tasks3"
},
"split_keywords": [
"tasks3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "350c0eb6037fc3df07455be875addd1b763e12b6683680afc1c26dafc5e91963",
"md5": "dfacf596f8ccb5c89c965deb2822d344",
"sha256": "b5fed0c5a9070a37fff06f4bf5d4fe61660f036941ca94a239a7c21dbe4bad6f"
},
"downloads": -1,
"filename": "tasks3-0.9.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "dfacf596f8ccb5c89c965deb2822d344",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.12",
"size": 14601,
"upload_time": "2025-01-21T00:41:28",
"upload_time_iso_8601": "2025-01-21T00:41:28.728056Z",
"url": "https://files.pythonhosted.org/packages/35/0c/0eb6037fc3df07455be875addd1b763e12b6683680afc1c26dafc5e91963/tasks3-0.9.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a108b1ab62550262f58a2e3bc30d1089e28eb31961bc31167e596eca8f5e37e1",
"md5": "9be20f1ce6ea781fe0bad5e8b81ab75c",
"sha256": "939c789c5d469a9a58bf8072a440a2f2c72dfbc034a240f3fb95f5fe29fa1f4b"
},
"downloads": -1,
"filename": "tasks3-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "9be20f1ce6ea781fe0bad5e8b81ab75c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 23436,
"upload_time": "2025-01-21T00:41:30",
"upload_time_iso_8601": "2025-01-21T00:41:30.600233Z",
"url": "https://files.pythonhosted.org/packages/a1/08/b1ab62550262f58a2e3bc30d1089e28eb31961bc31167e596eca8f5e37e1/tasks3-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-21 00:41:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hXtreme",
"github_project": "tasks3",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Click",
"specs": [
[
"==",
"8.1.6"
]
]
},
{
"name": "ruamel.yaml",
"specs": [
[
"==",
"0.18.6"
]
]
},
{
"name": "SQLAlchemy",
"specs": [
[
"==",
"2.0.36"
]
]
}
],
"tox": true,
"lcname": "tasks3"
}
JSON
