| Name | llama-index-readers-joplin JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | llama-index readers joplin integration |
| upload_time | 2024-08-22 14:23:53 |
| maintainer | alondmnt |
| docs_url | None |
| author | Your Name |
| requires_python | <4.0,>=3.8.1 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Joplin (Markdown) Loader
```bash
pip install llama-index-readers-joplin
```
> [Joplin](https://joplinapp.org/) is an open source note-taking app. Capture your thoughts and securely access them from any device.
This readme covers how to load documents from a `Joplin` database.
`Joplin` has a [REST API](https://joplinapp.org/api/references/rest_api/) for accessing its local database. This reader uses the API to retrieve all notes in the database and their metadata. This requires an access token that can be obtained from the app by following these steps:
1. Open the `Joplin` app. The app must stay open while the documents are being loaded.
2. Go to settings / options and select "Web Clipper".
3. Make sure that the Web Clipper service is enabled.
4. Under "Advanced Options", copy the authorization token.
You may either initialize the reader directly with the access token, or store it in the environment variable JOPLIN_ACCESS_TOKEN.
An alternative to this approach is to export the `Joplin`'s note database to Markdown files (optionally, with Front Matter metadata) and use a Markdown reader, such as ObsidianReader, to load them.
## Usage
Here's an example usage of the JoplinReader.
```python
import os
from llama_index.readers.joplin import JoplinReader
documents = JoplinReader(
access_token="<access_token>"
).load_data() # Returns list of documents
```
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-joplin",
"maintainer": "alondmnt",
"docs_url": null,
"requires_python": "<4.0,>=3.8.1",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/a0/44/97b5a2849d78a9be36a5bcbc3511c93778e3f87e1ef770e3586462632610/llama_index_readers_joplin-0.2.0.tar.gz",
"platform": null,
"description": "# Joplin (Markdown) Loader\n\n```bash\npip install llama-index-readers-joplin\n```\n\n> [Joplin](https://joplinapp.org/) is an open source note-taking app. Capture your thoughts and securely access them from any device.\n\nThis readme covers how to load documents from a `Joplin` database.\n\n`Joplin` has a [REST API](https://joplinapp.org/api/references/rest_api/) for accessing its local database. This reader uses the API to retrieve all notes in the database and their metadata. This requires an access token that can be obtained from the app by following these steps:\n\n1. Open the `Joplin` app. The app must stay open while the documents are being loaded.\n2. Go to settings / options and select \"Web Clipper\".\n3. Make sure that the Web Clipper service is enabled.\n4. Under \"Advanced Options\", copy the authorization token.\n\nYou may either initialize the reader directly with the access token, or store it in the environment variable JOPLIN_ACCESS_TOKEN.\n\nAn alternative to this approach is to export the `Joplin`'s note database to Markdown files (optionally, with Front Matter metadata) and use a Markdown reader, such as ObsidianReader, to load them.\n\n## Usage\n\nHere's an example usage of the JoplinReader.\n\n```python\nimport os\n\nfrom llama_index.readers.joplin import JoplinReader\n\ndocuments = JoplinReader(\n access_token=\"<access_token>\"\n).load_data() # Returns list of documents\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers joplin integration",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "494ce35e8349c74d155f2f2d5a18f2546dd2ef29097b679b6c226c17aa104ba5",
"md5": "4d394567129c3a1c8284129e94254257",
"sha256": "c9c6254f7594906b692a106cdfb6a6eab815654762e1106fa32dab8d2e1365a9"
},
"downloads": -1,
"filename": "llama_index_readers_joplin-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4d394567129c3a1c8284129e94254257",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 3926,
"upload_time": "2024-08-22T14:23:51",
"upload_time_iso_8601": "2024-08-22T14:23:51.623395Z",
"url": "https://files.pythonhosted.org/packages/49/4c/e35e8349c74d155f2f2d5a18f2546dd2ef29097b679b6c226c17aa104ba5/llama_index_readers_joplin-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a04497b5a2849d78a9be36a5bcbc3511c93778e3f87e1ef770e3586462632610",
"md5": "e30f796a4a42dbae32c57e47aa019632",
"sha256": "a11526af40be020c051462cc605581bfd809bee3fef9ca949a7421fc7e01b3ec"
},
"downloads": -1,
"filename": "llama_index_readers_joplin-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "e30f796a4a42dbae32c57e47aa019632",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 3608,
"upload_time": "2024-08-22T14:23:53",
"upload_time_iso_8601": "2024-08-22T14:23:53.153307Z",
"url": "https://files.pythonhosted.org/packages/a0/44/97b5a2849d78a9be36a5bcbc3511c93778e3f87e1ef770e3586462632610/llama_index_readers_joplin-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 14:23:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-joplin"
}
