diff --git a/.tag-notes.py.swp b/.tag-notes.py.swp new file mode 100644 index 0000000..447c256 Binary files /dev/null and b/.tag-notes.py.swp differ diff --git a/README.md b/README.md index 6698212..eee2cfb 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,29 @@ Automatically tag your Obsidian notes and add SEO metadata using a local LLM. +The script requires 4 frontmatter fields named as such: +- tags +- seo-title +- seo-description +- seo-keywords + ## Setup 1. **Install dependencies:** ```bash pip install pyyaml requests ``` - 2. **Make sure LM Studio is running** on `http://192.168.68.84:1234` with the `openai/gpt-oss-20b` model loaded 3. **Place these files in a directory:** - `tag-notes.py` (the main script) - `tag-taxonomy.yaml` (your tag taxonomy) +4. **Adjust Variables in 'tag-notes.py'** + - Edit the 'NOTES_FOLDER' variable to change the folder it searches + - Edit the 'MODEL_NAME' variable to change the LLM model + - Edit the 'LM_STUDIO_URL' variable to change URL of the LLM API +5. **Adjust preset tags** + - Edit the `tag-taxonomy.yaml` file to change what tags you want it to use. ## Usage @@ -22,10 +33,7 @@ Simply run the script: ./tag-notes.py ``` -It will automatically process all markdown files in: -`~/Documents/ejl-zk/40 Public/41 Notes/` - -To change the folder, edit the `NOTES_FOLDER` variable at the top of `tag-notes.py`. +It will automatically process all markdown files in the 'NOTES_FOLDER'. ## What it does @@ -63,7 +71,7 @@ Processing: /path/to/note.md ## Troubleshooting **LLM connection errors:** -- Check that LM Studio is running: `curl http://192.168.68.84:1234/v1/models` +- Check that LM Studio is running: `curl http://localhost:1234/v1/models` - Verify the model is loaded in LM Studio **No frontmatter found:** @@ -71,4 +79,4 @@ Processing: /path/to/note.md **Fields already populated:** - Script skips notes where all four fields are already filled -- To re-process a note, clear the specific fields you want regenerated \ No newline at end of file +- To re-process a note, clear the specific fields you want regenerated