Metadata-Version: 2.1
Name: obsidian_lab
Version: 0.2.4
Summary: Obsidian lab app
Home-page: https://github.com/cristianvasquez/obsidian-lab-py
Author: Cristian Vasquez
License: MIT
Project-URL: Bug Tracker, https://github.com/cristianvasquez/obsidian-lab-py/issues
Description: # Obsidian lab
        
        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](https://github.com/cristianvasquez/obsidian-lab) plugin.
        
        ## To install
        
        ```sh
        pip install obsidian-lab
        ```
        
        Usage:
        
        ```sh
        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:
        
        ```sh
        obsidian-lab ./examples
        ```
        
        After starting, you can list all the available scripts:
        
        > GET: http://127.0.0.1:5000/
        
        ```json
        {
          "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
        
        ```sh
        pip install -r requirements.txt
        ```
        
        try the app
        
        ```sh
        python ./app.py <scripts directory>
        ```
        
        ## Status
        
        This is a proof of concept.
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.6
Description-Content-Type: text/markdown
