https://github.com/gothenburgbitfactory/tasklib
A Python library for interacting with taskwarrior databases.
https://github.com/gothenburgbitfactory/tasklib
taskwarrior2
Last synced: 4 months ago
JSON representation
A Python library for interacting with taskwarrior databases.
- Host: GitHub
- URL: https://github.com/gothenburgbitfactory/tasklib
- Owner: GothenburgBitFactory
- License: bsd-3-clause
- Created: 2013-03-25T21:13:53.000Z (over 13 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-28T00:26:00.000Z (almost 2 years ago)
- Last Synced: 2025-03-29T11:11:15.710Z (over 1 year ago)
- Topics: taskwarrior2
- Language: Python
- Homepage: http://tasklib.readthedocs.org/en/latest/
- Size: 392 KB
- Stars: 151
- Watchers: 9
- Forks: 28
- Open Issues: 36
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
tasklib
=======
.. image:: https://travis-ci.org/robgolding/tasklib.png?branch=develop
:target: http://travis-ci.org/robgolding/tasklib
.. image:: https://coveralls.io/repos/robgolding/tasklib/badge.png?branch=develop
:target: https://coveralls.io/r/robgolding/tasklib?branch=develop
tasklib is a Python library for interacting with taskwarrior_ databases, using
a queryset API similar to that of Django's ORM.
Requirements
------------
* Python 3.5 or above
* taskwarrior_ v2.4.x or above.
Older versions of taskwarrior are untested and may not work.
Installation
------------
Install via pip::
pip install tasklib
Usage
-----
tasklib has a similar API to that of Django's ORM::
>>> from tasklib import TaskWarrior
>>> tw = TaskWarrior('~/.task')
>>> tasks = tw.tasks.pending()
>>> tasks
['Tidy the house', 'Learn German']
>>> tasks.filter(tags__contain='chores')
['Tidy the house']
>>> type(tasks[0])
>>> tasks[0].done()
>>> tasks = tw.tasks.pending()
>>> tasks
['Learn German']
>>> tasks[0]['tags'] = ['languages']
>>> tasks[0].save()
For more advanced usage, see the documentation_.
.. _taskwarrior: http://taskwarrior.org
.. _documentation: http://tasklib.readthedocs.org/en/latest/