Marty/topen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

doc: Add goal for configuration

Browse source
This commit is contained in:
Marty Oehme 2025-04-01 11:00:11 +02:00
parent bda8c3b992
commit da03afa758
Signed by: Marty
GPG key ID: 4E535BC19C61886E
1 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -48,7 +48,7 @@ feel free to do so by invoking it e.g. with `uvx git+https://git.martyoeh.me/Mar
## Configuration ## Configuration
```python ```python
TASK_RC = os.getenv("TASKRC", "~/.config/task/taskrc") TASK_RC = os.getenv("TASKRC", "~/.config/task/taskrc") # not implemented yet
TASK_DATA_DIR = os.getenv("TASKDATA", "~/.local/share/task") TASK_DATA_DIR = os.getenv("TASKDATA", "~/.local/share/task")
TOPEN_DIR = os.getenv("TOPEN_DIR", "~/.local/share/task/notes") TOPEN_DIR = os.getenv("TOPEN_DIR", "~/.local/share/task/notes")
TOPEN_EXT = os.getenv("TOPEN_EXT", "md") TOPEN_EXT = os.getenv("TOPEN_EXT", "md")
@ -57,5 +57,12 @@ TOPEN_EDITOR = os.getenv("EDITOR") or os.getenv("VISUAL", "nano")
TOPEN_QUIET = os.getenv("TOPEN_QUIET", False) TOPEN_QUIET = os.getenv("TOPEN_QUIET", False)
``` ```
These are all environment variables taken, needs improved documentation. These are all environment variables offered, needs improved documentation.
<!-- TODO: IMPROVE DOC --> <!-- TODO: IMPROVE DOC -->
Ultimately the goal would probably be to support reading from a taskwarrior 'taskrc' file,
which can then be optionally overwritten with env variables,
which can then be optionally overwritten with cli options.
This is not fully implemented -- we support the above environment variables
and cli options, that's it.