NoteSorcerer

choice of name, not finally decided between:

• NoteSorcerer
• NoteAlchemy
• logplug

Write Logseq Plugins in Python 3

Spyke your Logseq with Python Plugins!

its a wrapper for a typescript plugin, which is what logseq expect(a built typescript project). so why do this, well there are special cases where it better for you to code i python. in this case im gonna use it for ai stuff. using python is better than typescript

logspyq is the name of the plugin project its added as module. it is written by this awesome guy: Harshad Sharma, you can get his info from the the package setup.py './modules/logspyq/setup.py'

Example

Logseq plugin that responds to a keyboard shortcut and opens a specified page in the right sidebar:

from logspyq.api import LogseqPlugin

logseq = LogseqPlugin(name="Open ToDo", description="Open ToDo page in sidebar")


@logseq.App.registerCommandPalette("open_todo_in_sidebar", binding="ctrl+shift+t", label="Open ToDo in Sidebar")
async def go_to_todo_page(sid, event):
    todo_page = await logseq.Editor.getPage("TODO")
    await logseq.Editor.openInRightSidebar(todo_page.uuid)


if __name__ == "__main__":
    logseq.run(host="localhost", port=8484, debug=True)

Status

Alpha - This is a proof of concept and not ready for production use.

Installation

Requirements

• Python 3.8+
• Logseq Desktop App
• uv (not strictly required, but recommended)

Install

git clone https://github.com/hiway/logseq-python-plugin.git
cd logseq-python-plugin
hugo server -D
.\env\Scripts\activate

edge-tts --list-voices #https://pypi.org/project/edge-tts/
# Create a virtual environment
#pip install virtualenv
python -m venv venv
.\venv\Scripts\activate

#in linux, for others checkout https://github.com/KoljaB/RealtimeSTT#installation
sudo apt-get update
sudo apt-get install python3-dev
sudo apt-get install portaudio19-dev

pip install -e ./modules/logspyq
pip install -e ./modules/RealtimeSTT
# or for RealtimeSTT
pip install RealtimeSTT


# alternatively, go to all the modules root and run this
pip install -e . 

# back on the root of the project
python my_plugin.py

# or
cd examples 
python hello.py

# linux
python3 -m venv venv
source venv/bin/activate

pip install -e .  # Install logspyq, remember the dot at the end

uv sync
uv pip install -e .

Note: You will need to run source venv/bin/activate when in the project directory, every time you open a new terminal.

Install Logseq Python Plugin

if you make changes to the typescript plugin code

cd plugin
yarn
yarn build

1. Open Logseq Desktop App
2. Open the Plugins tab
3. Click Load unpacked plugin*
4. Select the plugin directory in the project directory
5. Click Install

*In case you don't see the Load unpacked plugin button, you need to enable the Developer Mode in the Settings > Advanced tab.

you need to go to the settings of the plugin and input the server url with the server url uvicorn is running on

Usage

Create a plugin

Create a new file my_plugin.py and add the following code:

from logspyq.api import LogseqPlugin

logseq = LogseqPlugin(name="My Plugin", description="My first Logseq Plugin")


# Register a keyboard shortcut
@logseq.App.registerCommandPalette("my_command", binding="ctrl+shift+h", label="My Command")
async def my_command(sid, event):
    print("Keyboard shortcut pressed")
    await logseq.App.showMsg("Hello from Python!")


# Register a slash command
@logseq.Editor.registerSlashCommand("My Slash Command")
async def my_slash_command(sid):
    print("My Slash Command was executed")
    await logseq.App.showMsg("My Slash Command was executed")


if __name__ == "__main__":
    logseq.run(host="localhost", port=8484, debug=True)

Run the plugin

python my_plugin.py