diff --git a/README.md b/README.md index ebac5f8..9a3e5a8 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ Does both by simply being invoked with `topen `. Automatically appends a small 'Note' annotation to your task so you know you have notes. + Should just work as-is without additional configuration in most taskwarrior setups. But can be configured through environment variables or cli options, see below. @@ -24,38 +25,16 @@ by doing `task note `. That's all there is to it. -## Installation - -You can install the script with your favorite python environment manager: - -```bash -uv tool install git+https://git.martyoeh.me/Marty/topen.git -``` - -```bash -pipx install git+https://git.martyoeh.me/Marty/topen.git -``` - -```bash -pip install git+https://git.martyoeh.me/Marty/topen.git -``` - -Or just manually copy the `topen` file to a directory in your PATH. - -If you just want to try the script out, -feel free to do so by invoking it e.g. with `uvx git+https://git.martyoeh.me/Marty/topen.git`. - ## Configuration -```python -TASK_RC = os.getenv("TASKRC", "~/.config/task/taskrc") -TASK_DATA_DIR = os.getenv("TASKDATA", "~/.local/share/task") -TOPEN_DIR = os.getenv("TOPEN_DIR", "~/.local/share/task/notes") -TOPEN_EXT = os.getenv("TOPEN_EXT", "md") -TOPEN_ANNOT = os.getenv("TOPEN_ANNOT", "Note") -TOPEN_EDITOR = os.getenv("EDITOR") or os.getenv("VISUAL", "nano") -TOPEN_QUIET = os.getenv("TOPEN_QUIET", False) -``` + -These are all environment variables taken, needs improved documentation. - +`TOPEN_DIR` + +`TOPEN_EXT` + +`TASKRC` + +`TASK_DATA` + +`TOPEN_ANNOT` diff --git a/pyproject.toml b/pyproject.toml index c1fd458..0bb91b0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,8 +8,5 @@ dependencies = [ "tasklib>=2.5.1", ] -[project.scripts] -topen = "topen:main" - [tool.pyright] typeCheckingMode = "standard"