Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ispringle/planwarrior
Command line day planner
https://github.com/ispringle/planwarrior
Last synced: 9 days ago
JSON representation
Command line day planner
- Host: GitHub
- URL: https://github.com/ispringle/planwarrior
- Owner: ispringle
- Created: 2021-11-17T21:30:52.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-16T11:57:12.000Z (almost 2 years ago)
- Last Synced: 2024-04-16T20:24:27.039Z (8 months ago)
- Language: Python
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Planwarrior
Planwarrior is a tool for visualizing a plantext dayplanner in the terminal
```
❯ python3 planwarrior
---------Good morning!---------
08:00 -- Plan day
08:30 -- Design planwarrior
...
...
10:00 -- Work on planwarrior poc
...
...
...
12:00 -- break for lunch
...
13:00 -- Finalize planwarrior poc
...
...
...
now
...
16:00 -- Publish planwarrior to GH
...
16:55 -- be lauded for my amazing snek skillz
---------Have a good evening!---------
```
## Usage
Specify a config file path and a plan file path:
```
python3 planwarrior --config path/to/config --plan path/to/plan
```
Utilize the default config location (`~/.config/planwarrionr/config.ini`) and
the current day's plan in the default plan directory
(`~/.local/share/planwarrior/`):
```
python3 planwarrior
```
## Dayplanner Format
The dayplanner format that Planwarrior uses is very simple Every line is a new
time entry. An entry consists of two parts, the start time and a description
Currently Planwarrior only supports times in 24-hour format, with `00:00`
equalling midnight. There are plans to support additional time formats, but
those are nice-to-haves and not priorities to me.
Here is an example dayplanner:
```
08:00 Plan day
08:30 Design planwarrior
10:00 Work on planwarrior poc
12:00 break for lunch
13:00 Finalize planwarrior poc
16:00 Publish planwarrior to GH
16:55 be lauded for my amazing snek skillz
```
## Configuration
Planwarrior's configuration looks like this:
```
'resolution': 30,
'start_time': '8:00',
'end_time': '17:00',
'start_message': "Good morning!",
'end_message': "Have a good evening!",
```
### resolution
This refers to the time interval for each line of output. Your dayplanner can
contain any time you wish, this is merely the interal used for the filler
between items.
### start_time and end_time
These refer to the start and end of your day. Usually this would mean when you
start working, but it can be anything you wish (or nothing at all). Any time
outside of this will still be visible if your day's plan includes it, but time
outside of this bounding will not be displayed by Planwarrior unless a plan
includes it.
### start_message and end_message
Planwarrior will optionally insert a message at the start and end deliminators
for the day.
## Future Features
- [ ] Taskwarrior integration
- [ ] Timewarrior integration?
- [X] Read plan from file
- [X] Read config from file
- [ ] Optional "live" mode?
- [ ] Unit tests
- [ ] `new` subcommand to create a plan file for current day
- [ ] Read plans embedded in Markdown files
- [ ] Add support for calDAV so that plans can be added to a calendar