pytodotxt


Namepytodotxt JSON
Version 2.0.0.post1 PyPI version JSON
download
home_pageNone
SummaryLibrary to access todo.txt-like task lists
upload_time2024-10-15 17:08:59
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseMIT License
keywords todotxt
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pytodotxt

A tiny library to access todo.txt-like task lists.


## Installation

To install pytodotxt, you can follow these steps to clone the repository,
and install the program.

    pip install pytodotxt

That’s all there is to do.


## Documentation

You can find the full documentation at <https://vonshednob.cc/pytodotxt/doc/>.


## Example usage

Here’s an example how to open a todo.txt file and print the description of all
tasks that are not marked as completed:

    import pytodotxt


    todotxt = pytodotxt.TodoTxt('todo.txt')
    todotxt.parse()

    for task in todotxt.tasks:
        if not task.is_completed:
            print(task.description)


Here is how you add a new task to an existing todo.txt file:

    import datetime

    import pytodotxt

    todotxt = pytodotxt.TodoTxt('todo.txt')
    todotxt.parse()

    task = pytodotxt.Task()
    task.parse('This is a new task')
    task.creation_date = datetime.date.today()

    todotxt.tasks.append(task)

    todotxt.save()


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pytodotxt",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "todotxt",
    "author": null,
    "author_email": "R <contact+pytodotxt@vonshednob.cc>",
    "download_url": "https://files.pythonhosted.org/packages/be/b7/dad26d5ec8ff4c0e6ed37414f5d5de53c3d9ceab67e077606e5a1ed44ea0/pytodotxt-2.0.0.post1.tar.gz",
    "platform": null,
    "description": "# pytodotxt\n\nA tiny library to access todo.txt-like task lists.\n\n\n## Installation\n\nTo install pytodotxt, you can follow these steps to clone the repository,\nand install the program.\n\n    pip install pytodotxt\n\nThat\u2019s all there is to do.\n\n\n## Documentation\n\nYou can find the full documentation at <https://vonshednob.cc/pytodotxt/doc/>.\n\n\n## Example usage\n\nHere\u2019s an example how to open a todo.txt file and print the description of all\ntasks that are not marked as completed:\n\n    import pytodotxt\n\n\n    todotxt = pytodotxt.TodoTxt('todo.txt')\n    todotxt.parse()\n\n    for task in todotxt.tasks:\n        if not task.is_completed:\n            print(task.description)\n\n\nHere is how you add a new task to an existing todo.txt file:\n\n    import datetime\n\n    import pytodotxt\n\n    todotxt = pytodotxt.TodoTxt('todo.txt')\n    todotxt.parse()\n\n    task = pytodotxt.Task()\n    task.parse('This is a new task')\n    task.creation_date = datetime.date.today()\n\n    todotxt.tasks.append(task)\n\n    todotxt.save()\n\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Library to access todo.txt-like task lists",
    "version": "2.0.0.post1",
    "project_urls": {
        "Repository": "https://vonshednob.cc/pytodotxt"
    },
    "split_keywords": [
        "todotxt"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f414a6efb5da4a15a4fd6f4492cca5bef2932bd9c096d7dc46c2becf4c95e834",
                "md5": "cfb46761395bd53016facc5640da23a5",
                "sha256": "1f1ed5b5799d04a9773c59741264755b86bc96164a7ab3580f02451e0d07fffa"
            },
            "downloads": -1,
            "filename": "pytodotxt-2.0.0.post1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cfb46761395bd53016facc5640da23a5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 9437,
            "upload_time": "2024-10-15T17:08:57",
            "upload_time_iso_8601": "2024-10-15T17:08:57.686009Z",
            "url": "https://files.pythonhosted.org/packages/f4/14/a6efb5da4a15a4fd6f4492cca5bef2932bd9c096d7dc46c2becf4c95e834/pytodotxt-2.0.0.post1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "beb7dad26d5ec8ff4c0e6ed37414f5d5de53c3d9ceab67e077606e5a1ed44ea0",
                "md5": "06408001ad2c94b74912449ff4dcde97",
                "sha256": "bdbdfc17840b18903d37784d1c58c49fdd8127323d9b6234e3992a74eea80310"
            },
            "downloads": -1,
            "filename": "pytodotxt-2.0.0.post1.tar.gz",
            "has_sig": false,
            "md5_digest": "06408001ad2c94b74912449ff4dcde97",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 105695,
            "upload_time": "2024-10-15T17:08:59",
            "upload_time_iso_8601": "2024-10-15T17:08:59.314885Z",
            "url": "https://files.pythonhosted.org/packages/be/b7/dad26d5ec8ff4c0e6ed37414f5d5de53c3d9ceab67e077606e5a1ed44ea0/pytodotxt-2.0.0.post1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-15 17:08:59",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pytodotxt"
}
        
Elapsed time: 0.34053s