Metadata-Version: 2.1
Name: trilium-py
Version: 0.7.4
Summary: Python client for ETAPI of Trilium Note. With some extra features powered by Python :)
Home-page: https://github.com/nriver/trilium-py
Author: Nriver
Author-email: 
Project-URL: Bug Reports, https://github.com/nriver/trilium-py/issues
Project-URL: Funding, https://github.com/nriver/trilium-py
Project-URL: Say Thanks!, https://github.com/nriver/trilium-py
Project-URL: Source, https://github.com/nriver/trilium-py/
Keywords: trilium,etapi,api client
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: BeautifulSoup4
Requires-Dist: requests
Requires-Dist: markdown2[all]
Requires-Dist: natsort
Requires-Dist: python-magic-bin ; platform_system == "Windows"
Requires-Dist: python-magic ; sys_platform == "darwin"
Requires-Dist: python-magic ; sys_platform == "linux"

# 🐍 trilium-py

Python client for ETAPI of Trilium Note.

[![Downloads](https://static.pepy.tech/badge/trilium-py)](https://pepy.tech/project/trilium-py)
[![Supported Versions](https://img.shields.io/pypi/pyversions/trilium-py.svg)](https://pypi.org/project/trilium-py)
[![Supported Versions](https://img.shields.io/pypi/v/trilium-py?color=%2334D058&label=pypi%20package)](https://pypi.org/project/trilium-py)
[![PyPI license](https://img.shields.io/pypi/l/trilium-py.svg)](https://pypi.python.org/pypi/trilium-py/)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)

<a href="https://github.com/Nriver"><img align="center" src="https://moe-counter--nriver1.repl.co/get/@Nriver_trilium-py"></a><br>

# 🦮 Table of Contents

<!--ts-->

- [🐍 trilium-py](#-trilium-py)
- [🦮 Table of Contents](#-table-of-contents)
- [🔧 Installation](#-installation)
- [📖 (Basic) Usage](#-basic-usage)
  - [🚀 Initialization](#-initialization)
  - [📊 Application Information](#-application-information)
  - [🔍 Search note](#-search-note)
  - [🏭 Create Note](#-create-note)
    - [🖼️ Create Image note](#️-create-image-note)
  - [👀 Get note](#-get-note)
  - [🔄 Update note](#-update-note)
  - [🗑️ Delete note](#️-delete-note)
  - [📅 Day note](#-day-note)
  - [📤 Export note](#-export-note)
- [(Advanced Usage) ✅ TODO List](#advanced-usage--todo-list)
  - [Add TODO item](#add-todo-item)
  - [Check/Uncheck a TODO item](#checkuncheck-a-todo-item)
  - [Update a TODO item](#update-a-todo-item)
  - [Delete a TDOO item](#delete-a-tdoo-item)
  - [Move yesterday's unfinished todo to today](#move-yesterdays-unfinished-todo-to-today)
- [(Advanced Usage) 🚚 Upload Markdown files](#advanced-usage--upload-markdown-files)
  - [Upload single Markdown file with images](#upload-single-markdown-file-with-images)
  - [Bulk upload Markdown files in a folder](#bulk-upload-markdown-files-in-a-folder)
    - [Import from VNote](#import-from-vnote)
    - [Import from Logseq](#import-from-logseq)
    - [Import from Obsidian](#import-from-obsidian)
    - [Import from Youdao Note/有道云笔记](#import-from-youdao-note有道云笔记)
    - [Import from other markdown software](#import-from-other-markdown-software)
- [🛠️ Develop](#️-develop)
- [🔗 Original OpenAPI Documentation](#-original-openapi-documentation)

<!--te-->

# 🔧 Installation

```bash
python3 -m pip install trilium-py --user
```

# 📖 (Basic) Usage

These are basic function that Trilium's ETAPI provides. Down below are some simple example code to use this package.

## 🚀 Initialization

If you have a ETAPI token, change the `server_url` and `token` to yours.

```python
from trilium_py.client import ETAPI

server_url = 'http://localhost:8080'
token = 'YOUR_TOKEN'
ea = ETAPI(server_url, token)
```

If you haven't created ETAPI token, you can create one with your password. Please note, you can only see this token
once, please save it if you want to reuse the token.

```python
from trilium_py.client import ETAPI

server_url = 'http://localhost:8080'
password = '1234'
ea = ETAPI(server_url)
token = ea.login(password)
print(token)
```

After initialization, you can use Trilium ETAPI with python now. The following are some examples.

## 📊 Application Information

To start with, you can get the application information like this.

```python
print(ea.app_info())
```

It should give you the version of your server application and some extra information.

## 🔍 Search note

Search note with keyword.

```python
res = ea.search_note(
    search="python",
)

for x in res['results']:
    print(x['noteId'], x['title'])
```

## 🏭 Create Note

You can create a simple note like this.

```python
res = ea.create_note(
    parentNoteId="root",
    title="Simple note 1",
    type="text",
    content="Simple note example",
    noteId="note1"
)
```

The `noteId` is not mandatory, if not provided, Trilium will generate a random one. You can retrieve it in the return.

```python
noteId = res['note']['noteId']
```

### 🖼️ Create Image note

Image note is a special kind of note. You can create an image note with minimal information like this. The `image_file`
refers to the path of image.

```python
res = ea.create_image_note(
    parentNoteId="root",
    title="Image note 1",
    image_file="shield.png",
)
```

## 👀 Get note

To retrieve the note's content.

```python
ea.get_note_content("note1")
```

You can get a note metadata by its id.

```python
ea.get_note(note_id)
```

## 🔄 Update note

Update note content

```python
ea.update_note_content("note1", "updated by python")
```

Modify note title

```python
ea.patch_note(
    noteId="note1",
    title="Python client moded",
)
```

## 🗑️ Delete note

Simply delete a note by id.

```python
ea.delete_note("note1")
```

## 📅 Day note

You can get the content of a certain date with `get_day_note`. The date string should be in format of "%Y-%m-%d", e.g. "
2022-02-25".

```python
es.get_day_note("2022-02-25")
```

Then set/update a day note with `set_day_note`. The content should be a (html) string.

```python
self.set_day_note(date, new_content)
```

## 📤 Export note

Export note comes in two formats `html` or `markdown`/`md`.

```python
res = ea.export_note(
    noteId='sK5fn4T6yZRI',
    format='md',
    savePath='/home/nate/data/1/test.zip',
)
```

# (Advanced Usage) ✅ TODO List

With the power of Python, I have expanded the basic usage of ETAPI. You can do something with todo list now.

## Add TODO item

You can use `add_todo` to add a TODO item, param is the TODO description

```python
ea.add_todo("买暖宝宝")
```

## Check/Uncheck a TODO item

param is the index of the TODO item

```python
ea.todo_check(0)
ea.todo_uncheck(1)
```

## Update a TODO item

Use `update_todo` to update a TODO item description at certain index.

```python
ea.update_todo(0, "去码头整点薯条")
```

## Delete a TDOO item

Remove a TODO item by its index.

```python
ea.delete_todo(1)
```

## Move yesterday's unfinished todo to today

As the title suggests, you can move yesterday's unfinished things to today. Unfinished todos will be deleted from
yesterday's note.

```python
ea.move_yesterday_unfinished_todo_to_today()
```

# (Advanced Usage) 🚚 Upload Markdown files

## Upload single Markdown file with images

You can import Markdown file with images into Trilium now! Trilium-py will help you to upload the images and fix the
links for you!

```python
res = ea.upload_md_file(
    parentNoteId="root",
    file="./md-demo/manjaro 修改caps lock.md",
)
```

## Bulk upload Markdown files in a folder

You can upload a folder with lots of Markdown files to Trilium and preserve the folder structure!

### Import from VNote

Say, upload all the notes from [VNote](https://github.com/vnotex/vnote), simply do this:

```python
res = ea.upload_md_folder(
    parentNoteId="root",
    mdFolder="~/data/vnotebook/",
    ignoreFolder=['vx_notebook', 'vx_recycle_bin', 'vx_images', '_v_images'],
)
```

### Import from Logseq

```python
res = ea.upload_md_folder(
    parentNoteId="root",
    mdFolder="/home/nate/data/logseq_data/",
    ignoreFolder=['assets', 'logseq'],
)
```

### Import from Obsidian

Obsidian has a very unique linking system for files. You should use [obsidian-export
](https://github.com/zoni/obsidian-export) to convert a Obsidian vault to regular Markdown files. Then you should be
able to import the note into Trilium with trilium-py.

Convert it first.

```bash
obsidian-export /path/to/your/vault /out
```

Then import just like a normal markdown, trilium-py will handle the images for you.

```python
res = ea.upload_md_folder(
    parentNoteId="root",
    mdFolder="E:/data/out",
)
```

### Import from Youdao Note/有道云笔记

Youdao does not provide an export feature anymore. Luckily, you can use <https://github.com/DeppWang/youdaonote-pull> to
download your notes and convert them into markdown files. After that, trilium-py should be able to help you import them.

```python
res = ea.upload_md_folder(
    parentNoteId="root",
    mdFolder="/home/nate/gitRepo/youdaonote-pull/out/",
)
```

### Import from other markdown software

In general, markdown files have variety of standards. You can always try import them with

```python
res = ea.upload_md_folder(
    parentNoteId="root",
    mdFolder="/home/nate/data/your_markdown_files/",
)
```

If there is any problem, please feel free to create an [issue](https://github.com/Nriver/trilium-py/issues/new).

# 🛠️ Develop

Install with pip egg link to make package change without reinstall.

```python
python -m pip install --user -e .
```

# 🔗 Original OpenAPI Documentation

The original OpenAPI document is [here](https://github.com/zadam/trilium/blob/master/src/etapi/etapi.openapi.yaml). You
can open it with [swagger editor](https://editor.swagger.io/).
