Joplin (Markdown) Loader
pip install llama-index-readers-joplin
Joplin 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 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:
- Open the
Joplinapp. The app must stay open while the documents are being loaded. - Go to settings / options and select "Web Clipper".
- Make sure that the Web Clipper service is enabled.
- 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.
import os
from llama_index.readers.joplin import JoplinReader
documents = JoplinReader(
access_token="<access_token>"
).load_data() # Returns list of documents
1 maintainer
Metadata
1 maintainer
Release files for llama-index-readers-joplin 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| llama_index_readers_joplin-0.7.0.tar.gz | 5.1 kB | Without provenance | Details for llama_index_readers_joplin-0.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| llama_index_readers_joplin-0.7.0-py3-none-any.whl | Python 3 | none | any | Details for llama_index_readers_joplin-0.7.0-py3-none-any.whl |
Total release size: 9.8 kB
Release files / llama_index_readers_joplin-0.7.0.tar.gz
| Download URL | llama_index_readers_joplin-0.7.0.tar.gz |
|---|---|
| Size | 5.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ccfe1cfb9053ba23136b065b7e77f373010be813912e86b535d8ad361aead6e7
|
|
BLAKE2b-256 checksum How to use checksums |
a43ebf85d51d8e42ed3f510e6bbc616d450e4f2916d6a7daf35ca02e6f1cbe40
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / llama_index_readers_joplin-0.7.0-py3-none-any.whl
| Download URL | llama_index_readers_joplin-0.7.0-py3-none-any.whl |
|---|---|
| Size | 4.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b6fa5c1443144a0b18fcef2e5aa36710d539ff165a8d0e8b42102e8ee50a100b
|
|
BLAKE2b-256 checksum How to use checksums |
f2659cfa1623fabcf68a40de51eb1bc8308e54756e9831c69ac6972c2d135cf5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for llama-index-readers-joplin 0.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
