Trilium ETAPI client generated by OpenAPI Generator
Project description
This is an auto-generated client for Trilium. It builds an API client using the etapi.openapi.yaml
provided by Trilium.
It's a simple Poetry project with a build script to invoke the OpenAPI Generator and extract dependencies. The generated trilium_client
, docs
, and README.md
artifacts are packaged and many unused files are ignored.
To build this project, activate a shell: (recommended)
poetry shell
And run:
poetry install --with=dev
scons
To clean, run:
scons --clean
Following is the README produced by the generator.
trilium-client
External Trilium API
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen For more information, please visit https://github.com/zadam/trilium
Requirements.
Python 3.7+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import trilium_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import trilium_client
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import trilium_client
from trilium_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:37740/etapi
# See configuration.py for a list of all supported configuration parameters.
configuration = trilium_client.Configuration(
host = "http://localhost:37740/etapi"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: EtapiTokenAuth
configuration.api_key['EtapiTokenAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['EtapiTokenAuth'] = 'Bearer'
# Configure HTTP basic authorization: EtapiBasicAuth
configuration = trilium_client.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Enter a context with an instance of the API client
with trilium_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = trilium_client.DefaultApi(api_client)
backup_name = 'backup_name_example' # str | If the backupName is e.g. \"now\", then the backup will be written to \"backup-now.db\" file
try:
api_instance.create_backup(backup_name)
except ApiException as e:
print("Exception when calling DefaultApi->create_backup: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost:37740/etapi
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | create_backup | PUT /backup/{backupName} | |
DefaultApi | create_note | POST /create-note | |
DefaultApi | create_revision | POST /notes/{noteId}/revision | |
DefaultApi | delete_attribute_by_id | DELETE /attributes/{attributeId} | |
DefaultApi | delete_branch_by_id | DELETE /branches/{branchId} | |
DefaultApi | delete_note_by_id | DELETE /notes/{noteId} | |
DefaultApi | export_note_subtree | GET /notes/{noteId}/export | |
DefaultApi | get_app_info | GET /app-info | |
DefaultApi | get_attribute_by_id | GET /attributes/{attributeId} | |
DefaultApi | get_branch_by_id | GET /branches/{branchId} | |
DefaultApi | get_day_note | GET /calendar/days/{date} | |
DefaultApi | get_inbox_note | GET /inbox/{date} | |
DefaultApi | get_month_note | GET /calendar/months/{month} | |
DefaultApi | get_note_by_id | GET /notes/{noteId} | |
DefaultApi | get_note_content | GET /notes/{noteId}/content | |
DefaultApi | get_week_note | GET /calendar/weeks/{date} | |
DefaultApi | get_year_note | GET /calendar/years/{year} | |
DefaultApi | import_zip | POST /notes/{noteId}/import | |
DefaultApi | login | POST /auth/login | |
DefaultApi | logout | POST /auth/logout | |
DefaultApi | patch_attribute_by_id | PATCH /attributes/{attributeId} | |
DefaultApi | patch_branch_by_id | PATCH /branches/{branchId} | |
DefaultApi | patch_note_by_id | PATCH /notes/{noteId} | |
DefaultApi | post_attribute | POST /attributes | |
DefaultApi | post_branch | POST /branches | |
DefaultApi | post_refresh_note_ordering | POST /refresh-note-ordering/{parentNoteId} | |
DefaultApi | put_note_content_by_id | PUT /notes/{noteId}/content | |
DefaultApi | search_notes | GET /notes |
Documentation For Models
- AppInfo
- Attribute
- Branch
- CreateNoteDef
- Error
- Login201Response
- LoginRequest
- Note
- NoteWithBranch
- SearchResponse
Documentation For Authorization
EtapiTokenAuth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
EtapiBasicAuth
- Type: HTTP basic authentication
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for trilium_client-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2899843f83c2a67f7ba2405e8cf1f248390803ec51a85da179ac3c2c23bea397 |
|
MD5 | 6b9bb84b572914ea24753e7305e1cdf9 |
|
BLAKE2b-256 | 03155bd16adadebfb84bfbbb1d5a83ee7668d25730babc0c81c51e54b59e0c85 |