Skip to content

cristianvasquez/obsidian-lab-py

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Obsidian lab python server

Say you have a terrific script in python to:

  • Find similar notes to the current one.
  • Translate a text.
  • Know what was your mood the last three months, just reading your Obsidian vault.
  • Whatever wonder you have under the sleeve :D

And you want to see if it's helpful in Obsidian.

Then you can:

  1. Expose your script with this app
  2. Try it out with the obsidian lab plugin.

To install

pip install obsidian-lab

Usage:

obsidian-lab <scripts directory>

This will run a mini web server that exposes the scripts of the directory specified.

There are some examples in the ./examples directory, to run do:

obsidian-lab ./examples

After starting, you can list all the available scripts:

GET: http://127.0.0.1:5000/

{
  "scripts": [
    "http://127.0.0.1:5000/scripts/hello_world",
    "http://127.0.0.1:5000/scripts/random",
    "http://127.0.0.1:5000/scripts/to_upper_case"
  ]
}

To add new scripts, copy them in the scripts directory.

Build

Install the dependencies

pip install -r requirements.txt

try the app

python ./src/obsidian_lab/app.py ./examples

Status

This is a proof of concept.

About

obsidian-lab, python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages