| Name | rest-uploader JSON |
| Version |
1.22.0
JSON |
| download |
| home_page | https://github.com/kellerjustin/rest-uploader |
| Summary | REST API File Uploader for Joplin |
| upload_time | 2024-04-11 20:35:08 |
| maintainer | None |
| docs_url | None |
| author | Justin Keller |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2019, Justin Keller Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
rest_uploader
joplin
rest-uploader
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
watchdog
requests
tabulate
click
img_processor
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# rest-uploader
REST API File Uploader for Joplin
[API Reference](https://joplinapp.org/api/references/rest_api/)
Joplin client will need Webclipper service enabled.
* Go to Tools -> Web Clipper Options -> Enable Web Clipper Service
### History
2018-09-24
This program was created to upload files from a folder specified in the
PATH variable to Joplin. The following resource was helpful in figuring out
the logic for Watchdog:
https://stackoverflow.com/questions/18599339/python-watchdog-monitoring-file-for-changes
Tested with the following extensions:
.md
.txt
.pdf
.png
.jpg
.url
.csv
Caveat:
Uploader only triggered upon new file creation, not modification
### Tesseract
In order for OCR text recognition to work, you'll need to download and
install Tesseract. Windows systems may require that you add a path variable
in order for it to work.
### Poppler
Poppler is required for PDF processing.
For Windows, download x86 binary and add to environment path.
https://anaconda.org/conda-forge/poppler
### Running application
Launch using the executable rest_uploader, specify the monitoring path
as an argument. You'll need your Joplin API key the first time you
launch. If your API key changes or gets pasted incorrectly, delete the .api_token.txt file that gets stored to the package.
` rest_uploader /path/to/directory `
To launch as python module:
` python -m rest_uploader.cli /path/to/directory `
### Languages other than English
Version 0.4.0 added language support via Tesseract (check Tesseract docs). To enable, use the cli -l or --language argument.
The following example will OCR text using the German dictionary:
` rest_uploader /path/to/directory --language ger `
### Additional Command Line Options added in version 1.8.0
By default notes will be dropped into a notebook called "inbox".
Specify a different upload notebook by specifying a destination from the
command line using -d or --destination
rest_uploader will fail if the specified notebook does not exist
I am guessing if you have two notebooks with the same name, it will dump
new notes in the first one it finds.
Default server = 127.0.0.1
To specify a different server, use the -s or --server cli option
Default port = 41184
To specify a different port, use the -p or --port cli option
Default autotagging behavior = yes
To turn off autotagging, use the -t or --autotag option
Example:
` rest_uploader /path/to/directory -t no `
It doesn't matter if the options are before or after the path. Path is mandatory, though.
The following example will upload newly created notes to the Taxes Notebook, and OCR in German:
` rest_uploader -d "Taxes" -l ger /path/to/directory `
### Additional Command Line Options added in version 1.11.0
Added autorotation switch to turn off if this behavior is not wanted. By default, after performing OCR, the application will rotate the image according to how the OCR was able to detect text. Turn this off using the -r command line switch:
` rest_uploader -r no /path/to/directory `
Added moveto option to specify a directory in which to place processed files. Use the -o option to specify a moveto directory By default this is off but in the background it uses the operating system's temp directory as a placeholder for the option to indicate "off" since the option requires a valid path. Do not attempt to use the OS temp dir as a moveto directory. Example of using the option:
` rest_uploader /path/to/directory -o /path/to/moveto/directory `
Raw data
{
"_id": null,
"home_page": "https://github.com/kellerjustin/rest-uploader",
"name": "rest-uploader",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "rest_uploader, joplin, rest-uploader",
"author": "Justin Keller",
"author_email": "Justin Keller <kellerjustin@protonmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fa/c0/b91da9e7cda0760fa968c6d30e4e2ba11ce1402266541d72887e2c22d32d/rest_uploader-1.22.0.tar.gz",
"platform": null,
"description": "# rest-uploader\nREST API File Uploader for Joplin\n\n[API Reference](https://joplinapp.org/api/references/rest_api/)\n\nJoplin client will need Webclipper service enabled.\n* Go to Tools -> Web Clipper Options -> Enable Web Clipper Service\n\n### History\n2018-09-24\nThis program was created to upload files from a folder specified in the\nPATH variable to Joplin. The following resource was helpful in figuring out\nthe logic for Watchdog:\nhttps://stackoverflow.com/questions/18599339/python-watchdog-monitoring-file-for-changes\n\nTested with the following extensions:\n.md\n.txt\n.pdf\n.png\n.jpg\n.url\n.csv\n\nCaveat:\nUploader only triggered upon new file creation, not modification\n\n### Tesseract\nIn order for OCR text recognition to work, you'll need to download and\ninstall Tesseract. Windows systems may require that you add a path variable\nin order for it to work.\n\n### Poppler\nPoppler is required for PDF processing.\nFor Windows, download x86 binary and add to environment path.\nhttps://anaconda.org/conda-forge/poppler\n\n### Running application\nLaunch using the executable rest_uploader, specify the monitoring path\nas an argument. You'll need your Joplin API key the first time you\nlaunch. If your API key changes or gets pasted incorrectly, delete the .api_token.txt file that gets stored to the package.\n\n` rest_uploader /path/to/directory `\n\nTo launch as python module:\n\n` python -m rest_uploader.cli /path/to/directory `\n\n### Languages other than English\nVersion 0.4.0 added language support via Tesseract (check Tesseract docs). To enable, use the cli -l or --language argument.\nThe following example will OCR text using the German dictionary:\n` rest_uploader /path/to/directory --language ger `\n\n### Additional Command Line Options added in version 1.8.0\nBy default notes will be dropped into a notebook called \"inbox\".\nSpecify a different upload notebook by specifying a destination from the\ncommand line using -d or --destination\n\nrest_uploader will fail if the specified notebook does not exist\nI am guessing if you have two notebooks with the same name, it will dump\nnew notes in the first one it finds.\n\nDefault server = 127.0.0.1\nTo specify a different server, use the -s or --server cli option\n\nDefault port = 41184\nTo specify a different port, use the -p or --port cli option\n\nDefault autotagging behavior = yes\nTo turn off autotagging, use the -t or --autotag option\nExample:\n` rest_uploader /path/to/directory -t no `\n\nIt doesn't matter if the options are before or after the path. Path is mandatory, though.\nThe following example will upload newly created notes to the Taxes Notebook, and OCR in German:\n` rest_uploader -d \"Taxes\" -l ger /path/to/directory `\n\n### Additional Command Line Options added in version 1.11.0\nAdded autorotation switch to turn off if this behavior is not wanted. By default, after performing OCR, the application will rotate the image according to how the OCR was able to detect text. Turn this off using the -r command line switch:\n` rest_uploader -r no /path/to/directory `\n\nAdded moveto option to specify a directory in which to place processed files. Use the -o option to specify a moveto directory By default this is off but in the background it uses the operating system's temp directory as a placeholder for the option to indicate \"off\" since the option requires a valid path. Do not attempt to use the OS temp dir as a moveto directory. Example of using the option:\n` rest_uploader /path/to/directory -o /path/to/moveto/directory `\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2019, Justin Keller Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "REST API File Uploader for Joplin",
"version": "1.22.0",
"project_urls": {
"Bug Tracker": "https://github.com/cerealkella/rest-uploader/issues",
"Homepage": "https://github.com/cerealkella/rest-uploader"
},
"split_keywords": [
"rest_uploader",
" joplin",
" rest-uploader"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "525d19bc1cfa485369c1c43869291d722c537f7da507eb5f26a8455a13d1b038",
"md5": "1867c8ec0b3594cbe025a6e2ce142f19",
"sha256": "85bcba439bb872de7ee40baa9fe61796ef9a1116abb5e9296c97509fd3cb6e7a"
},
"downloads": -1,
"filename": "rest_uploader-1.22.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1867c8ec0b3594cbe025a6e2ce142f19",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 12107,
"upload_time": "2024-04-11T20:35:06",
"upload_time_iso_8601": "2024-04-11T20:35:06.187486Z",
"url": "https://files.pythonhosted.org/packages/52/5d/19bc1cfa485369c1c43869291d722c537f7da507eb5f26a8455a13d1b038/rest_uploader-1.22.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fac0b91da9e7cda0760fa968c6d30e4e2ba11ce1402266541d72887e2c22d32d",
"md5": "7c2fcb365443466b91370fb26965acb6",
"sha256": "62b6c56566e950570d99aa106e10d3cc7adfdd2229f84e8fa1e90884d5156d68"
},
"downloads": -1,
"filename": "rest_uploader-1.22.0.tar.gz",
"has_sig": false,
"md5_digest": "7c2fcb365443466b91370fb26965acb6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19760,
"upload_time": "2024-04-11T20:35:08",
"upload_time_iso_8601": "2024-04-11T20:35:08.046738Z",
"url": "https://files.pythonhosted.org/packages/fa/c0/b91da9e7cda0760fa968c6d30e4e2ba11ce1402266541d72887e2c22d32d/rest_uploader-1.22.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 20:35:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kellerjustin",
"github_project": "rest-uploader",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "watchdog",
"specs": [
[
">=",
"3.0.0"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.31.0"
]
]
},
{
"name": "tabulate",
"specs": [
[
">=",
"0.9.0"
]
]
},
{
"name": "click",
"specs": [
[
">=",
"8.1.3"
]
]
},
{
"name": "img_processor",
"specs": [
[
">=",
"0.20.0"
]
]
}
],
"tox": true,
"lcname": "rest-uploader"
}
