{"id":26187868,"url":"https://github.com/burgr033/todotxtui","last_synced_at":"2025-03-11T23:52:09.637Z","repository":{"id":49213716,"uuid":"315408136","full_name":"burgr033/todotxtui","owner":"burgr033","description":"TODOTXTUI - an intuitive TUI for TODO.txt files","archived":false,"fork":false,"pushed_at":"2024-03-04T12:27:41.000Z","size":148,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-05T22:58:11.098Z","etag":null,"topics":["cui","py-cui","python","todo","todotxt","todotxt-cli","tui"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/burgr033.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-11-23T18:40:39.000Z","updated_at":"2024-03-19T23:42:37.000Z","dependencies_parsed_at":"2024-03-04T13:56:15.471Z","dependency_job_id":null,"html_url":"https://github.com/burgr033/todotxtui","commit_stats":null,"previous_names":["burgr033/todotxtui"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burgr033%2Ftodotxtui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burgr033%2Ftodotxtui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burgr033%2Ftodotxtui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burgr033%2Ftodotxtui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/burgr033","download_url":"https://codeload.github.com/burgr033/todotxtui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243130976,"owners_count":20241177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cui","py-cui","python","todo","todotxt","todotxt-cli","tui"],"created_at":"2025-03-11T23:52:09.211Z","updated_at":"2025-03-11T23:52:09.631Z","avatar_url":"https://github.com/burgr033.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT LOGO --\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=https://github.com/burgr033/todotxtui.git\u003e\u003cimg src=.github/logo.gif/\u003e\u003c/a\u003e\n  \u003ch3 align=\"center\"\u003eTODOTXTUI - an intuitive TUI for TODO.txt files\u003c/h3\u003e\n\u003c/p\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n  \u003csummary\u003e\u003ch2 style=\"display: inline-block\"\u003eTable of Contents\u003c/h2\u003e\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgements\"\u003eAcknowledgements\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nTo get a local copy up and running follow these simple steps.\n\n### Installation\n\n1. Clone the repo\n   ```sh\n   git clone https://github.com/burgr033/todotxtui.git\n   ```\n2. Install requirements\n   ```sh\n   pip install -r requirements.txt\n   ```\n3. Run!\n   ```sh\n   python todotxtui.py\n   ```   \n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\n### config.json\n* debug\n  * (true|false) debug parameter (generates log file in running dir)\n* unicode_borders\n  * (true|false) If you want unicode rounded sexy corners or not\n* color_projects\n  * (true|false) Feature is implemented but useless due to the limited colors of py_cui\n* todo_file_path\n  * File Path for your Todo.txt file\n* WIP_identifier\n  * This is the Keyword which is applied when you put something in \"DOING\" (e.g. \"@WIP\")\n* alternate_today\n  * alternate keyword for today (maybe in your language)\n* alternate_tomorrow\n  * alternate keyword for tomorrow (maybe in your language)\n* editor_path\n  * full path to editor for opening text files\n### Modes\n* OverView Mode\n  * in overview mode you can cycle through widgets with arrows keys, and enter focus mode with enter.\n    * you can also toggle some functions with following keys: \n      * q - quit application\n      * TAB - cycle through widgets without using arrow keys and ENTER\n      * f - find and mark | opens find/mark dialog (also upon opening the find/mark dialog the previously marked items are cleared)\n      * r - refresh | refreshes the whole GUI and reloads changes made to todo.txt file from any other source\n      * o - opens todo.txt in default system editor.\n* Focus Mode\n  * TODO Item Widget: Just hammer in your new TODO and press enter.\n    * if you want a due date, than use due:2020-03-10 format. If you want to use due date today or tomorrow you can just type due:today or due:tomorrow (or the alternate keywords you set in config.json) it will be replaced with the according date. Today will be marked red and tomorrow will be marked yellow.\n  * FUNNEL in this widget is everything you are not currently working on.\n    * ESC - for exiting the widget.\n    * ENTER on respective item moves it to \"DOING\"\n  * DOING in this widget is everything you are working on at the moment\n    * ESC - for exiting the widget.\n    * ENTER on respective item moves it to \"DONE\"\n  * DONE in this widget is everything finished.\n    * ESC - for exiting the widget.\n    * DEL for deleting items from the todo.txt list entirely\n\n## Screenshots\n\n![Workflow](.github/workflow.gif)\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\nnothing, really\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n\u003c!-- NOTE --\u003e\n## Note\n* Please note, that I don't know what the fuck I am doing. I just google stuff and use code snippets from StackOverflow. If you killed your todo.txt using this application, joke on you.\nNo Backup? No Mercy!\n* Also note, that this is fully compatible with todotxt standard, but does not fully implement it, so it is not strictly following todotxt syntax (e.g. there is a completion date set upon completion, but todotxt standard says when you set completion date, you need creation date, and i don't provide creation date simply, because i needed the space on the screen)\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\n[@burgr033](https://twitter.com/burgr033) - mail@cigh.de\n\nProject Link: [https://github.com/burgr033/todotxtui](https://github.com/burgr033/todotxtui)\n\n\u003c!-- ACKNOWLEDGEMENTS --\u003e\n## Acknowledgements\n\n* [jwoldek, creator of py_cui](https://github.com/jwlodek/py_cui)\n* [telday, whose py_cui todotxt script served as the base of mine](https://gist.github.com/telday/227d39502d2fe017deb8b8b3c3b007f9)\n* [Nicke Manarin, ScreenToGif (used for screenshots)](https://github.com/NickeManarin/ScreenToGif)\n* [Plaintext Productivity provided by todotxt](http://todotxt.org/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fburgr033%2Ftodotxtui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fburgr033%2Ftodotxtui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fburgr033%2Ftodotxtui/lists"}