https://github.com/burgr033/todotxtui
TODOTXTUI - an intuitive TUI for TODO.txt files
https://github.com/burgr033/todotxtui
cui py-cui python todo todotxt todotxt-cli tui
Last synced: 7 months ago
JSON representation
TODOTXTUI - an intuitive TUI for TODO.txt files
- Host: GitHub
- URL: https://github.com/burgr033/todotxtui
- Owner: burgr033
- License: mit
- Created: 2020-11-23T18:40:39.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T12:27:41.000Z (over 1 year ago)
- Last Synced: 2025-03-05T22:58:11.098Z (8 months ago)
- Topics: cui, py-cui, python, todo, todotxt, todotxt-cli, tui
- Language: Python
- Homepage:
- Size: 145 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
TODOTXTUI - an intuitive TUI for TODO.txt files
Table of Contents
## Getting Started
To get a local copy up and running follow these simple steps.
### Installation
1. Clone the repo
```sh
git clone https://github.com/burgr033/todotxtui.git
```
2. Install requirements
```sh
pip install -r requirements.txt
```
3. Run!
```sh
python todotxtui.py
```
## Usage
### config.json
* debug
* (true|false) debug parameter (generates log file in running dir)
* unicode_borders
* (true|false) If you want unicode rounded sexy corners or not
* color_projects
* (true|false) Feature is implemented but useless due to the limited colors of py_cui
* todo_file_path
* File Path for your Todo.txt file
* WIP_identifier
* This is the Keyword which is applied when you put something in "DOING" (e.g. "@WIP")
* alternate_today
* alternate keyword for today (maybe in your language)
* alternate_tomorrow
* alternate keyword for tomorrow (maybe in your language)
* editor_path
* full path to editor for opening text files
### Modes
* OverView Mode
* in overview mode you can cycle through widgets with arrows keys, and enter focus mode with enter.
* you can also toggle some functions with following keys:
* q - quit application
* TAB - cycle through widgets without using arrow keys and ENTER
* f - find and mark | opens find/mark dialog (also upon opening the find/mark dialog the previously marked items are cleared)
* r - refresh | refreshes the whole GUI and reloads changes made to todo.txt file from any other source
* o - opens todo.txt in default system editor.
* Focus Mode
* TODO Item Widget: Just hammer in your new TODO and press enter.
* 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.
* FUNNEL in this widget is everything you are not currently working on.
* ESC - for exiting the widget.
* ENTER on respective item moves it to "DOING"
* DOING in this widget is everything you are working on at the moment
* ESC - for exiting the widget.
* ENTER on respective item moves it to "DONE"
* DONE in this widget is everything finished.
* ESC - for exiting the widget.
* DEL for deleting items from the todo.txt list entirely
## Screenshots
## Roadmap
nothing, really
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Note
* 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.
No Backup? No Mercy!
* 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)
## Contact
[@burgr033](https://twitter.com/burgr033) - mail@cigh.de
Project Link: [https://github.com/burgr033/todotxtui](https://github.com/burgr033/todotxtui)
## Acknowledgements
* [jwoldek, creator of py_cui](https://github.com/jwlodek/py_cui)
* [telday, whose py_cui todotxt script served as the base of mine](https://gist.github.com/telday/227d39502d2fe017deb8b8b3c3b007f9)
* [Nicke Manarin, ScreenToGif (used for screenshots)](https://github.com/NickeManarin/ScreenToGif)
* [Plaintext Productivity provided by todotxt](http://todotxt.org/)