Skip to main content

Obsidian lab app

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obsidian_lab-0.2.5.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

obsidian_lab-0.2.5-py3-none-any.whl (7.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page