Compare commits
No commits in common. "d94c58d7156dd4b5b24f7151889b3510ae105f6d" and "678d986e8fbba89b5554b7ca63bf28873e836739" have entirely different histories.
d94c58d715
...
678d986e8f
2 changed files with 11 additions and 35 deletions
43
README.md
43
README.md
|
|
@ -10,6 +10,7 @@ Does both by simply being invoked with `topen <task-id>`.
|
||||||
|
|
||||||
Automatically appends a small 'Note' annotation to your task so you know you have notes.
|
Automatically appends a small 'Note' annotation to your task so you know you have notes.
|
||||||
|
|
||||||
|
<!-- TODO: Implement configuration options -->
|
||||||
Should just work as-is without additional configuration in most taskwarrior setups.
|
Should just work as-is without additional configuration in most taskwarrior setups.
|
||||||
But can be configured through environment variables or cli options, see below.
|
But can be configured through environment variables or cli options, see below.
|
||||||
|
|
||||||
|
|
@ -24,38 +25,16 @@ by doing `task note <id>`.
|
||||||
|
|
||||||
That's all there is to it.
|
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
|
## Configuration
|
||||||
|
|
||||||
```python
|
<!-- TODO: Stub section -->
|
||||||
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`
|
||||||
<!-- TODO: IMPROVE DOC -->
|
|
||||||
|
`TOPEN_EXT`
|
||||||
|
|
||||||
|
`TASKRC`
|
||||||
|
|
||||||
|
`TASK_DATA`
|
||||||
|
|
||||||
|
`TOPEN_ANNOT`
|
||||||
|
|
|
||||||
|
|
@ -8,8 +8,5 @@ dependencies = [
|
||||||
"tasklib>=2.5.1",
|
"tasklib>=2.5.1",
|
||||||
]
|
]
|
||||||
|
|
||||||
[project.scripts]
|
|
||||||
topen = "topen:main"
|
|
||||||
|
|
||||||
[tool.pyright]
|
[tool.pyright]
|
||||||
typeCheckingMode = "standard"
|
typeCheckingMode = "standard"
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue