Installation and start using

SmooSense provides CLI, Python package and MacOS app (coming). You can choose any one that you prefer.

Prerequisites

Install uv (an extremely fast Python package manager):

curl -LsSf https://astral.sh/uv/install.sh | sh

Start a new terminal after you just installed uv.

Option 1: CLI

CLI is recommended if you just want to quickly explore data.

Install or update SmooSense CLI:

uv tool install -U smoosense

To run SmooSense, go to the folder containing your data files and simply run command:

sense

# 👉 Open in your web browser: http://localhost:8000

Option 2: Python package

Python SDK is useful when you want to add your customization or integrate with your other web apps.

It is suggested to do it in a virtual environment to install the package:

pip install smoosense

After installation, start SmooSense:

from smoosense.app import SmooSenseApp

app = SmooSenseApp().create_app()

@app.route('/your-other-page')
def your_other_page():
    return 'hello world'

def start():
    app.run(port=8000)

if __name__ == '__main__':
    start()