{"id":14065833,"url":"https://github.com/whateverforever/zettelwarmer","last_synced_at":"2025-07-29T21:33:41.254Z","repository":{"id":93345613,"uuid":"322848993","full_name":"whateverforever/zettelwarmer","owner":"whateverforever","description":"CLI Tool for Zettlr/Obsidian to help you browse random notes. The older the note, the more likely it will be shown.","archived":false,"fork":false,"pushed_at":"2021-03-22T17:42:17.000Z","size":2034,"stargazers_count":24,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-14T07:09:47.584Z","etag":null,"topics":["note-taking","obsidian","obsidian-md","spaced-repetition","zettelkasten","zettelkasten-methodology","zettlr"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/whateverforever.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-12-19T13:02:28.000Z","updated_at":"2024-06-16T01:46:25.000Z","dependencies_parsed_at":"2023-03-07T18:00:42.647Z","dependency_job_id":null,"html_url":"https://github.com/whateverforever/zettelwarmer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whateverforever%2Fzettelwarmer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whateverforever%2Fzettelwarmer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whateverforever%2Fzettelwarmer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whateverforever%2Fzettelwarmer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/whateverforever","download_url":"https://codeload.github.com/whateverforever/zettelwarmer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228052622,"owners_count":17862103,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["note-taking","obsidian","obsidian-md","spaced-repetition","zettelkasten","zettelkasten-methodology","zettlr"],"created_at":"2024-08-13T07:04:45.490Z","updated_at":"2024-12-04T05:31:00.903Z","avatar_url":"https://github.com/whateverforever.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Zettelwarmer\n\n\u003e An additional tool to Zettlr/Obsidian to randomly show you Zettels. Useful if you want to be reminded\n\u003e of what you have thought before, to find new possible interconnections and insights.\n\u003e\n\u003e Gives more weight to Zettels that haven't been seen (by this tool) in a while. The older the\n\u003e Zettel, the more probable it will be picked. See Andy Matuschak's [Evergreen note maintenance approximates spaced repetition](https://notes.andymatuschak.org/z2HUE4ABbQjUNjrNemvkTCsLa1LPDRuwh1tXC?stackedNotes=z6yfTwYekzvBkVjeH7WBUrSAJhyGTMYDAyYW7).\n\u003e\n\u003e Also see [zettelcon](https://github.com/whateverforever/zettelcon) for automatic backlink creation.\n\n![Screenshot of the heatmap of Zettel ages and subsequently opened zettels](screenshot.png)\n\n## Usage\n\nPut it somewhere in your path, or make a shell alias to use it with your favorite flags.\nI added a reminder to my `/etc/motd` to warm up my Zettels once in a while, and do it using this alias:\n\n```\nalias heat-zettels=\"python /...path.../zettelwarmer.py --folder /...path.../Zettels/ --numzettels 6\"\nalias show-zettels=\"python /...path.../zettelwarmer.py --folder /...path.../Zettels/ --visualize-only\"\n```\n\n```\n(base) ➜  ~ python zettelwarmer.py --help\nusage: zettelwarmer.py [-h] [-f FOLDER] [-n NUMZETTELS] [-if IMPORTANCE_FUN]\n                       [-s SUFFIXES [SUFFIXES ...]] [-p PICKLENAME] [-vo]\n\nTool to revisit random Zettels from your collection. Gives more weight to old\nZettels that you haven't seen in a while.\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -f FOLDER, --folder FOLDER\n                        Path to folder with all the zettels in it. Defaults to\n                        current directory.\n  -n NUMZETTELS, --numzettels NUMZETTELS\n                        Number of Zettels to pick and open.\n  -if IMPORTANCE_FUN, --importance-fun IMPORTANCE_FUN\n                        Function of age, used to weight note-picking\n                        probability. Possible values are linear, quadratic,\n                        log\n  -s SUFFIXES [SUFFIXES ...], --suffixes SUFFIXES [SUFFIXES ...]\n                        List of valid suffixes to consider as Zettel files.\n                        Defaults to .md\n  -p PICKLENAME, --picklename PICKLENAME\n                        Name of the pickle file to save file ages into. Will\n                        be saved in the Zettel folder.\n  -vo, --visualize-only\n                        Do not open or modify anything, only show the heatmap.\n```\n\n## Requirements\n\n~~As of now, it's specific to macOS by using the built-in `open` command.~~\nIn theory, macOS, linux and windows should be supported. On macOS, `open` is used to display the note files, on linux it's `xdg-open`. Windows doesn't seem to have a dedicated open command. If you're using windows and it doesn't work, please contact me. These commands require you to have a markdown viewer like Typora or MacDown setup as the standard tool to open markdown files.\n\n## Feature Ideas\n\n- [ ] Calculate how long it will take until all (or say 90%) of notes are \"warm\" (i.e. not older than X)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhateverforever%2Fzettelwarmer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwhateverforever%2Fzettelwarmer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhateverforever%2Fzettelwarmer/lists"}