https://github.com/thekoc/devonthink-python
Python API for Devonthink 3 utilizes AppleScript (JXA) and PyObjC.
https://github.com/thekoc/devonthink-python
applescript devonthink python
Last synced: 6 months ago
JSON representation
Python API for Devonthink 3 utilizes AppleScript (JXA) and PyObjC.
- Host: GitHub
- URL: https://github.com/thekoc/devonthink-python
- Owner: thekoc
- License: mit
- Created: 2023-05-01T21:27:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-18T06:46:37.000Z (over 1 year ago)
- Last Synced: 2025-01-09T08:42:51.429Z (6 months ago)
- Topics: applescript, devonthink, python
- Language: Python
- Homepage:
- Size: 4.84 MB
- Stars: 54
- Watchers: 5
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# PyDT3 - The Python API For DEVONthink 3
This project aims to let you use Python to interact with DEVONthink 3 with ease.
Ulike many other API wrapper projects, PyDT3 is documented through docstring. Therefore can benefit from code completion and documentation in code editors.
To install, just run
```python
pip install pydt3
```
Most of the classes and methods map directly to the AppleScript APIs.
For example:
```python
from pydt3 import DEVONthink3
dt3 = DEVONthink3()
for db in dt3.databases:
print(db.name)
selected_record = dt3.selected_records[0]
print(selected_record.name)
```
```applescript
tell application "DEVONthink 3"
repeat with db in databases
log name of db as string
end repeat
set selected_record to item 1 of selected records
log name of selected_record as string
end tell
```
These two scripts do the same thing.
The project is still in early stage. Not all properties and methods have been implemented.
## Installation
### Pip
```bash
pip install pydt3
```
## Quick Start
```python
from pydt3 import DEVONthink3
dtp3 = DEVONthink3()
inbox = dtp3.inbox
# create a new folder in inbox
dtp3.create_location('new-group-from-pydt3', inbox)
# get selected records
records = dtp3.selected_records
# get the first selected record and print its information
if records:
first = records[0]
print(first.name)
print(first.type)
print(first.reference_url)
print(first.plain_text)
# create record in inbox
record = dtp3.create_record_with({
'name': 'hello-from-pydt3',
'type': 'markdown',
'plain text': '# Hello from pydt3',
}, inbox)
```
## Requirements
- DEVONthink 3
- Python 3.7+
- PyObjC
(See `requirements.txt` for more information.)
## Work With ChatGPT
### Add Tags to Selected Records Using ChatGPT
Put this [script](https://github.com/thekoc/devonthink-python/releases/download/example-scripts-v0.03/GPT.Add.Tags.scptd.zip) into `~/Library/Application Scripts/com.devon-technologies.think3/Contextual Menu` and run it from contextual menu in DEVONthink (The record must be in selected state).
And voilà, the tags are added based on contents automatically.
Note: You are required to have an [API key](https://platform.openai.com/account/api-keys) from OpenAI. The first time you run the script, a prompt will ask you to enter key.
The key will be store in Incoming group for DEVONthink (usually `Inbox`). You can see the file `__openai_api_key__` generated there. You can move it to other opened database but don't change it's name.
### Auto Writing / Summarizing Using ChatGTP
[This script](https://github.com/thekoc/devonthink-python/releases/download/example-scripts-v0.03/GPT.Expand.Content.zip) lets you to insert `<>` into your text and then generate the text based on the token.
Put the script into `~/Library/Application Scripts/com.devon-technologies.think3/Toolbar`. Restart the DEVONthink and you will see the script in the toolbar customization window.
### About the Release Scripts
The script bundles provided by the project are packed by PyInstaller so that you can run them without Python installation. But the size is relatively large. You can write your own version if you do have Python installed (with required packages.) See codes in examples for more information.
## Remarks
For those properties that are not implemented, you can still use the through the fallback method. Just that you cannot use the python style naming convention (Basically it will pass the python names directly to JXA).
```python
# a.propertyName (int) is not implemented in PyDT3.
p = a.propertyName()
a.propertyName = (p + 1)
```
This project uses PyObjC to execute AppleScript code in Objective-C then wrap them in Python.
The bridging part is inspired by [py-applescript](https://github.com/rdhyee/py-applescript).
Many of the APIs are generated by ChatGPT from the DEVONthink's AppleScript dictionary.
Notes used as examples are imported from [The Blue Book](https://github.com/lyz-code/blue-book), a personal wiki shared by [lyz-code](https://github.com/lyz-code).
## Limitations
- The APIs are not fully tested. Please report any issues.
- ~~Rich texts in AppleScript are converted to strings in Python, which causes style information loss.~~
Now rich text is partially supported.
- ~~Collections of elements (eg. `database.records`) are converted to lists in Python. While in Applescript they are retrieved in a lazy manner. This may cause performance issues with large collections.~~
Now they are wrapped in an `OSAObjArray` object and are evaluated lazily.
## TODO
- [ ] Implement all APIs
- [ ] Ability to execute JXA code snippets.
- [ ] `whose` filter for `OSAObjArray` container.