{
    "info": {
        "author": "Sophie Au",
        "author_email": "some.person@web.de",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# todoster\n> A simple command line todo list\n\n[![GitHub (pre-)release](https://img.shields.io/github/release/sophieau/todoster/all.svg)](https://github.com/sophieau/todoster/releases)\n[![PyPI](https://img.shields.io/pypi/v/todoster.svg)](https://pypi.python.org/pypi/todoster)\n![Python](https://img.shields.io/badge/python-v3.6-blue.svg)\n[![GitHub issues](https://img.shields.io/github/issues/sophieau/todoster.svg)](https://github.com/SophieAu/todoster/issues)\n[![license](https://img.shields.io/github/license/sophieau/todoster.svg)](https://github.com/SophieAu/todoster/blob/master/LICENSE)\n\n\n![](header.png)\n\n[Features](#features) | [Installation](#installation) | [Usage](#usage) | [Troubleshooting](#troubleshooting) | [Similar Apps](#similar-apps)\n\n## Features\n\ntodoster is conciously kept simple. For other, potentially more feature rich apps, check out [similar apps](#similar-apps) below.\n\nNevertheless, it does have _some_ features:\n\n* **Manage Tasks:** Like any good todo app, todoster lets you add, edit, complete and delete tasks. Tasks can have a due date and a location, as well as be high priority and belong to a project.\n* **Manage Projects:** Projects are color coded and can be assigned tasks. Projects can also be archived if e.g. they are completed.\n* **Different Todo List Views:** You can have your tasks displayed by due date, project and location, as well as choose to display only the tasks for the next two weeks and tasks without a due date.\n\nFeatures I conciously chose not to have:\n* recurring tasks\n* statistics\n* \"version history\" of tasks\n\n\n## Installation\n\ntodoster is available on [PyPI](https://pypi.python.org/pypi/todoster). This is the easiest way to install it. All dependencies will be installed automatically.\n\n```sh\npip install todoster\n```\n\n\n## Usage\n```\nUSAGE\n    $ todoster [COMMAND]\n\nCOMMANDS\n    None        display default todo list\n    task, t     manage tasks\n    project, p  manage projects\n    show, s     display todo lists\n```\n\ntodoster creates a `.todoster` folder in your home directory (`~/`) where it saves all tasks and projects. If you want to specify a different folder for these files, you need to set the `TODOSTER_DIR` in your `.bashrc` like so:\n\n    export TODOSTER_DIR=/path/that/you/want\n\n### Managing Tasks\n```\nUSAGE\n    $ todoster task [COMMAND]\n\nCOMMANDS\n    add          add a task\n    edit [ID]    edit a task\n    check [ID]   mark a task as completed/not completed\n    delete [ID]  delete a task\n\nARGUMENTS\n    ID  id of the task\n\nOPTIONS (add and edit only)\n    -t/--title [TITLE]        set title\n    -d/--date [DATE]          set due date\n    -p/--project [SHORTCODE]  set project\n    -l/--location [LOCATION]  set location\n    -i/--important            mark task as important\n\nEXAMPLES\n    $ todoster task add -t \"new task\" -d 10.12.2018 -l \"Office\"\n    $ todoster task edit 23 -d 15.12.2018\n    $ todoster task edit 23 -i\n    $ todoster task check 23\n    $ todoster task delete 23\n```\n### Managing Projeccts\n```\nUSAGE\n    todoster project [COMMAND]\n\nCOMMANDS\n    l, list [-a/--all]      list projects (incl. archived if -a flag is set)\n    a, add                  create project\n    e, edit [SHORTCODE]     edit project\n    c, archive [SHORTCODE]  archive project\n    d, delete [SHORTCODE]   delete project and all associated tasks\n\nARGUMENTS\n    SHORTCODE  shortcode of the project\n\nOPTIONS (add and edit only)\n    -t/--title [TITLE]          set title\n    -s/--shortcode [SHORTCODE]  set shortcode\n    -c/--color [COLOR]          set color\n\nVALID COLOR VALUES\n    default\n    grey\n    red\n    green\n    yellow\n    blue\n    purple\n    cyan\n    white\n\nEXAMPLES\n    $ todoster project add -t \"React Website Tutorial\" -s react-tute -c green\n    $ todoster project edit react-tute -c purple\n    $ todoster project archive react-tute\n    $ todoster project delete react-tute\n    $ todoster project list -a\n```\n\n### The Different List Views\n```\nUSAGE\n    todoster show [COMMAND]\n\nCOMMANDS\n    current   show tasks due in this or the next week\n    backlog   show tasks without a due date\n    date      show tasks grouped by week\n    location  show tasks grouped by location\n    priority  show tasks grouped by priority\n    project   show tasks grouped by project\n\nOPTIONS\n    -a, --all      show tasks belonging to archived projects\n    -c, --checked  show checked tasks with no due date or a due date in the future\n    -p, --past     show checked tasks with a due date in the past (only works in combination with -c)\n```\n\n\n## Troubleshooting\n\n#### Bug Reports and Feature Requests\nBug reports and feature requests are very much appreciated. Please contact me on Twitter ([@SolviAu](https://twitter.com/solviau)) or open an issue [here](https://github.com/SophieAu/todoster/issues/new).\n\n\n## Similar Apps\nThe app was originally inspired by [taskbook](https://github.com/klauscfhq/taskbook). Other cli apps I found are:\n* [committask](https://github.com/ZeroX-DG/CommitTasks)\n* [td](https://github.com/Swatto/td)\n\n---\n> [sophieau.github.io](https://sophieau.github.io) \u2013 Twitter [@SolviAu](https://twitter.com/solviau) \u2013 \u00a9 2018, [MIT Licence](LICENSE)\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/sophieau/todoster",
        "keywords": "command-line-tool,productivity,todo,task-manager",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "todoster",
        "package_url": "https://pypi.org/project/todoster/",
        "platform": "",
        "project_url": "https://pypi.org/project/todoster/",
        "project_urls": {
            "Homepage": "https://github.com/sophieau/todoster"
        },
        "release_url": "https://pypi.org/project/todoster/1.0.0/",
        "requires_dist": [
            "isoweek (>=1.3.3)"
        ],
        "requires_python": ">=3.6",
        "summary": "A simple command line todo list.",
        "version": "1.0.0"
    },
    "last_serial": 4453911,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "cc0906bdfe50152920273983a3f13fe5",
                    "sha256": "eb5a01b5072385531861d2093b2607b638eda7791507fc057922cbd0425a2bbf"
                },
                "downloads": -1,
                "filename": "todoster-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "cc0906bdfe50152920273983a3f13fe5",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 14346,
                "upload_time": "2018-11-05T17:32:50",
                "url": "https://files.pythonhosted.org/packages/80/00/0ba27ef12cc4c9710fb2e33538d4897e7a3afeed491109353522ac5e4c47/todoster-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "96aea54191bfa44302f3ba8090f04e5c",
                    "sha256": "0ffd3694bad1737d9b714c55afbd9cdca643478966e58661cea8ca4104a96754"
                },
                "downloads": -1,
                "filename": "todoster-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "96aea54191bfa44302f3ba8090f04e5c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 19369,
                "upload_time": "2018-11-05T17:32:52",
                "url": "https://files.pythonhosted.org/packages/db/31/d59fb1af2a294ce0d384cc80a7927cd0723871ea5c247d8e7421eb2ae5e4/todoster-1.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "cc0906bdfe50152920273983a3f13fe5",
                "sha256": "eb5a01b5072385531861d2093b2607b638eda7791507fc057922cbd0425a2bbf"
            },
            "downloads": -1,
            "filename": "todoster-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cc0906bdfe50152920273983a3f13fe5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 14346,
            "upload_time": "2018-11-05T17:32:50",
            "url": "https://files.pythonhosted.org/packages/80/00/0ba27ef12cc4c9710fb2e33538d4897e7a3afeed491109353522ac5e4c47/todoster-1.0.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "96aea54191bfa44302f3ba8090f04e5c",
                "sha256": "0ffd3694bad1737d9b714c55afbd9cdca643478966e58661cea8ca4104a96754"
            },
            "downloads": -1,
            "filename": "todoster-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "96aea54191bfa44302f3ba8090f04e5c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 19369,
            "upload_time": "2018-11-05T17:32:52",
            "url": "https://files.pythonhosted.org/packages/db/31/d59fb1af2a294ce0d384cc80a7927cd0723871ea5c247d8e7421eb2ae5e4/todoster-1.0.0.tar.gz"
        }
    ]
}