Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0xbismarck/omnivore2trilium
Export highlights from Omnivore directly into Trilium Notes
https://github.com/0xbismarck/omnivore2trilium
etapi highlighting note-taking notes omnivore personal-knowledge-management pkm trilium
Last synced: about 1 month ago
JSON representation
Export highlights from Omnivore directly into Trilium Notes
- Host: GitHub
- URL: https://github.com/0xbismarck/omnivore2trilium
- Owner: 0xbismarck
- License: agpl-3.0
- Created: 2024-02-18T13:05:46.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-13T12:14:27.000Z (7 months ago)
- Last Synced: 2024-08-02T06:14:26.421Z (4 months ago)
- Topics: etapi, highlighting, note-taking, notes, omnivore, personal-knowledge-management, pkm, trilium
- Language: Python
- Homepage:
- Size: 83 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-trilium - omnivore2trilium - commit/0xbismarck/omnivore2trilium) (🖥️ ETAPI / 🤖 ETAPI programs)
README
# omnivore2trilium
Export highlights from Omnivore directly into Trilium Notes
## Installation
Python 3 is required on both Linux and Windows.
Download the omnivore2trilium git repo.
### On Linux
```
python3 -m venv venv
source venv/bin/activate
pip install omnivoreql
pip install trilium_py
```
### On Windows
```
python -m venv venv
venv\Scripts\activate.bat
pip install omnivoreql
pip install trilium_py
```
## API Tokens
Authenticating to both Omnivore and Trilium Notes requires an API token for each service.
Instructions to generate tokens are at the following links
- https://docs.omnivore.app/integrations/api.html#getting-an-api-token - Omnivore
- Trilium Notes:
- Click on the "Main menu"
- Click "Options"
- Click "ETAPI"
- Click "Create New ETAPI Token"
Put the token's in the "file" matching each token to the line that starts with the service. Each line of the file must start with either "omnivore:" or "trilium:" so that the software knows which token belong to a particular service. Lines that do not start with the required prefix will be ignored by the software.
## Usage
Trilium needs to be open for it to receive highlights this tool.
Make sure that the Python virtual environment is activated:
From the Linux terminal:
```source venv/bin/activate```
From the Windows commandline (cmd.exe):
```venv\Scripts\activate.bat```
Note: On Windows type 'python' instead of python3.
Basic execution:
```python3 omnivore2trilium.py -k keys```
This uses the keys (within the key file ) to retrieve highlights from 10 notes and store them in the root note.
```python3 omnivore2trilium.py -k keys -d 30 -a all -l 100 -p BE5Id3adb33f```
This will retrieve Omnivore highlights made in the last 30 days and places within Trilium under the Note with Id "BE5Id3adb33f".
### Available options
```
usage: omnivore2trilium.py [-h] [-k KEYS] [-a {inbox,archive,all}] [-p PARENTNOTEID] [-d DAYS] [-o] [-l LIMIT]
Omnivore2Trilium: Send your Omnivore Highlights to Trilium Notes
options:
-h, --help show this help message and exit
-k KEYS, --keys KEYS File containing tokens to authenticate to Omnivore and Trilium.
-a {inbox,archive,all}, --archive {inbox,archive,all}
Extract highlights from the inbox, archive, or all. (default is all)
-p PARENTNOTEID, --parentNoteId PARENTNOTEID
Note ID of the parent Trilium Note. (defaults to root)
-d DAYS, --days DAYS Number of days ago the the articles were highlighted.
-o, --overwrite Overwrite content of existing note. (Erases any changes in Trilium)
-l LIMIT, --limit LIMIT
Limit number of articles returned by Omnivore (limit 100)
-i, --iterate Iterate Omnivore queries to get passed 100 article
limit
```
### Locating the NoteID
The noteId for any note can be found by clicking the "Note Info" icon towards the top of the note. After clicking the icon, you will see the field called "Note ID".
This is the value needed for the parentNoteId.
## Shoutouts
Special thanks to
- [OmnivoreQL](https://github.com/yazdipour/OmnivoreQL)
- [Trilium-py](https://github.com/Nriver/trilium-py)
These projects made Omnivore2trilium possibile.
Additionally thanks to [Omnivore](https://omnivore.app/) and [Trilium Notes](https://github.com/zadam/trilium) for making two great FOSS projects.