Skip to main content

A commandline tool to create and manage tasks and todos.

Project description

tasks3

https://img.shields.io/pypi/v/tasks3.svg https://github.com/hXtreme/tasks3/actions/workflows/tox-test.yml/badge.svg Documentation Status Updates

A commandline tool to create and manage tasks and todos.

Features

Create Tasks

Easily create tasks from the commandline and delegate them to folders.

Create a task in a specific folder with default settings.

$ 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.

$ 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.

Search Tasks

You can search for tasks using various filters.

You can search for tasks with a specific importance value.

$ 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.

$ 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.

$ 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.

$ 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.

$ 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"
}

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.

eval "$(tasks3 shell $(basename $SHELL))"
  • TODO: Edit existing tasks.

  • TODO: Delete tasks.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tasks3-0.5.1.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tasks3-0.5.1-py2.py3-none-any.whl (13.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file tasks3-0.5.1.tar.gz.

File metadata

  • Download URL: tasks3-0.5.1.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for tasks3-0.5.1.tar.gz
Algorithm Hash digest
SHA256 d0297b627415105e2dd8b0dd9e5c15eca2743d6c00f7d1623fd230f394d0e389
MD5 e46ca012f702c49e22950736577fbc83
BLAKE2b-256 f5e775f5962a965f41da26ff8be9ac07276dfe4ca90f462516b422a5f2d837dc

See more details on using hashes here.

File details

Details for the file tasks3-0.5.1-py2.py3-none-any.whl.

File metadata

  • Download URL: tasks3-0.5.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for tasks3-0.5.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5af0ba91df1ef199db7af60bd4d88529e4e480a2f6f45920f92a9d852b67c598
MD5 6d938621b7736c6b4df56e6a2c4ddd91
BLAKE2b-256 346d000036993754a4232882429a77c2ade7a4b268b9eb59297c8fe1e48e3bb7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page