https://github.com/funkyfuture/todo.txt-pylib

An easy to extend Python 3 library to parse, manipulate, query and render tasks in the todo.txt-format in a pythonic manner.
https://github.com/funkyfuture/todo.txt-pylib

Last synced: 13 days ago
JSON representation

An easy to extend Python 3 library to parse, manipulate, query and render tasks in the todo.txt-format in a pythonic manner.

• Host: GitHub
• URL: https://github.com/funkyfuture/todo.txt-pylib
• Owner: funkyfuture
• License: isc
• Archived: true
• Created: 2016-03-29T10:17:10.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-04-03T16:45:34.000Z (over 8 years ago)
• Last Synced: 2024-09-18T16:18:52.447Z (about 2 months ago)
• Language: Python
• Size: 18.6 KB
• Stars: 13
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
todo.txt-pylib

==============

``todo.txt-pylib`` is a Python 3 library to parse, manipulate, query and render

tasks in the `todo.txt`_-format in a pythonic manner. It can easily be extended.

Installation

------------

::

    pip install todo.txt-pylib

Usage

-----

.. code:: python

    from todotxt import Task

    task = Task('do something')

There are more advanced examples in the `documentation`_.

Hacking

-------

`Clone the repo`_, setup and activate a `virtual envrionment`_, then

::

    ./setup.py develop

    pip install requirements-dev.txt

    ./run-tests

Resources

---------

-  `Documentation with examples and API`_

-  `Package at the warehouse`_

.. _todo.txt: https://todotxt.com

.. _documentation: http://todotxt-pylib.readthedocs.org/en/latest/

.. _Clone the repo: https://help.github.com/articles/fork-a-repo/

.. _virtual envrionment: https://github.com/berdario/pew

.. _Documentation with examples and API: http://todotxt-pylib.readthedocs.org/en/latest/

.. _Package at the warehouse: https://warehouse.python.org/project/todo.txt-pylib/