{"id":16367687,"url":"https://github.com/jackgruber/joplin-tools","last_synced_at":"2025-03-21T01:31:07.215Z","repository":{"id":158957274,"uuid":"288019028","full_name":"JackGruber/Joplin-Tools","owner":"JackGruber","description":"Various Python tools for Joplin (Hotfolder, PDF Previews, ToDo List) and AutoIt (JoplinWinBackup) for Backups under Windows. ","archived":false,"fork":false,"pushed_at":"2021-05-03T18:35:39.000Z","size":177,"stargazers_count":44,"open_issues_count":0,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-11T02:50:59.365Z","etag":null,"topics":["api","autoit","hotfolder","joplin","joplin-api","python","python-hotfolder-script"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JackGruber.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-08-16T20:26:22.000Z","updated_at":"2024-09-27T10:38:32.000Z","dependencies_parsed_at":"2023-06-15T02:30:15.996Z","dependency_job_id":null,"html_url":"https://github.com/JackGruber/Joplin-Tools","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JackGruber%2FJoplin-Tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JackGruber%2FJoplin-Tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JackGruber%2FJoplin-Tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JackGruber%2FJoplin-Tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JackGruber","download_url":"https://codeload.github.com/JackGruber/Joplin-Tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221810749,"owners_count":16884186,"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":["api","autoit","hotfolder","joplin","joplin-api","python","python-hotfolder-script"],"created_at":"2024-10-11T02:50:35.816Z","updated_at":"2024-10-28T08:59:41.000Z","avatar_url":"https://github.com/JackGruber.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Joplin tools\n\nVarious Python and AutoIt tools for Joplin. \nPython use the Joplin API for communication.\n\n## Additional python modules\n\nPlease einstall the following python modules:\n\n- [PyMuPDF](https://github.com/pymupdf/PyMuPDF)\n- [Click](https://click.palletsprojects.com)\n- Requests\n\n```console\npip install click\npip install requests\npip install PyMuPDF\n```\n\n## Tools\n\n- [hotfolder.py](#hotfolderpy)\n- [add_pdf_previews.py](#add_pdf_previewspy)\n- [todo_overview.py](#todo_overviewpy)\n- [note_overview.py](#note_overviewpy)\n- [JoplinWinBackup.au3](#JoplinWinBackupau3)\n\n### Parameters for all tools\n\n- `-t` Joplin Authorisation token. Default: `Ask for token and store token`\n- `-u` Joplin Web Clipper URL. Default `http://localhost:41184`\n\nIf no token is specified, the script will ask for it and then store it in the script's directory for later use when called without the `-t` option.\n\n### hotfolder.py\n\n---\n\n\u003e \u0026#11088; Almost all functions are available as [Hotfolder](https://github.com/JackGruber/joplin-plugin-hotfolder) plugin.\n\nMonitor a folder an add the Files to Joplin as a Note.\n\nImages and text (Mimetype `text/plain`) are inserted directly into the note, other Files are added as attachment. The files are deleted after processing.\n\nIf you want to insert additional files directly as text, define them with the `--as-plain` switch.\n\n**Example**\n\n```python\npython hotfolder.py -d \"Import\" -p \"C:\\JoplinImport\"\n```\n\n**Parameters**\n\n- `-d` Specify the notebook in which to place newly created notes. Default: `Import`\n- `-p` Folder for monitoring\n- `--as-plain` Specify file extensions comma separated for input as text. Example: `.md, .json`\n- `--tag` Specify of comma separated Tags which should be added to the note. Example: `scan, todo`\n- `--preview` Create a preview of the first site from an PDF file.\n\n### add_pdf_previews.py\n\n---\n\nSearch for notes with a PDF attachment an create a preview of the first PDF Site and add this Preview to Note.\n\n\u003cimg src=\"img/pdf_preview.jpg\"\u003e\n\n**Parameters**\n\n- `-n` Defines the notebook in which notes with PDF file should be searched. Default: `All notebooks`\n\n**Example**\n\n```python\npython add_pdf_previews.py -n \"Import\"\n```\n\n### todo_overview.py\n\n---\n\n\u003e \u0026#11088; The same functionality is now available as [Note overview](https://github.com/JackGruber/joplin-plugin-note-overview) plugin.\n\nCreates or Updates a note with a list of all open ToDo's. All to-dos that have been exceeded are marked with a ❗.\n\n\u003cimg src=\"img/todo_overview.jpg\"\u003e\n\n**Parameters**\n\n- `-n` Defines the notebook in which the new Note should be created.\n- `--title` Defines the title for the note to be updated or createt. Default `ToDo overview`\n- `--as-todo` Create the note as a ToDo\n- `--tag` Specify of comma separated Tags which should be added to the note. Example: `scan, todo`\n\n**Example**\n\n```python\npython todo_overview.py --title \"Open ToDo's\" --as-todo --tag \"importend\"\n```\n\n### note_overview.py\n\n---\n\n\u003e \u0026#11088; The same functionality is now available as [Note overview](https://github.com/JackGruber/joplin-plugin-note-overview) plugin.\n\nCreates or updates a note with a list of all notes that match the search query.\n\n\u003cimg src=\"img/note_overview.jpg\"\u003e\n\n**Parameters**\n\n- `-n` Defines the notebook in which the new Note should be created.\n- `--title` Defines the title for the note to be updated or createt. Default `Note overview`\n- `--tag` Specify of comma separated Tags which should be added to the note. Example: `project, overview`\n- `--query` Specify the [seach query](https://joplinapp.org/#searching) for the Notes like in Joplin\n- `--order_by` Specify the field for the sorting of the Table content. (All Joplin fields can be used for sorting). Default `user_updated_time`\n- `--order_dir` Sorting sequence, possible values `DESC` or `ASC`. Default `DESC`\n\n**Example**\n\n```python\npython note_overview.py --query \"tag:! tag:\\\"project xyz\\\"\" -n Scans --title \"Overview Important Notes\" --tag \"!\"\n```\n\n### JoplinWinBackup.au3\n\n---\n\n\u003e \u0026#11088; There is now a backup plugin available! [Simple Backup](https://github.com/JackGruber/joplin-plugin-backup) plugin.\n\nSince there is no possibility for an automatic backup under windows, the required key combinations are sent to joplin via autoit to create a backup.\n\nRename the `JoplinWinBackup.ini.example` to `JoplinWinBackup.ini` and place it in the same folder es the `JoplinWinBackup.au3` or `JoplinWinBackup.exe`.\n\nThe latest JoplinWinBackup.exe can be downloaded from the [latest release](https://github.com/JackGruber/Joplin-Tools/releases/latest/download/JoplinWinBackup.exe).\n\nOptions from the JoplinWinBackup.ini\n\n- `JoplinWinBackup` Defines the Path to Joplin exe. Default `C:\\Program Files\\Joplin\\Joplin.exe`\n- `backup_folder` Path to store the Backups. Default `C:\\Backup`\n- `key_combo` Key combo to get to the \"JEX - Joplin export File\" menue. Default `fej`\n- `save_dialog` Dialog Title of the save/eport dialog. Default `Speichern unter`\n- `ask_for_start` Ask if backup should be started. Default `1`, `0` = No, `1`= Yes\n- `backup_file_add_date` Append date to the Backupfile. Default `1`, `0` = No, `1`= Yes\n- `backup_file_add_time` Append time to the Backupfile. Default `1`, `0` = No, `1`= Yes\n- `backup_file_name` Filename of the Backup. Default `joplin_backup.jex`\n- `overwrite_file` Overwrite existing backup file. Default `0`, `0` = No, `1`= Yes\n\n## Changelog\n\n## 2020-12-26 v1.5.1\n\n- Fix two outputs on the console\n\n## 2020-12-26 v1.5.0\n\n- Added note_overview.py script\n\n### add_pdf_previews.py\n\n- Keep original updated time when adding PDF preview\n\n### JoplinWinBackup\n\n- Read complet key_combo from ini\n- Read sleep value wait_overwrite_dialog from ini\n\n## 2020-11-18 v1.4.0\n\n❗ breaking changes, requires at least Joplin v1.4.11  ❗\n\n- Change to new Joplin API\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjackgruber%2Fjoplin-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjackgruber%2Fjoplin-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjackgruber%2Fjoplin-tools/lists"}