Local development

$ pip install peliqan

$ pip install peliqan --upgrade

from peliqan import Peliqan

jwt = "MY_JWT_TOKEN"             # see Admin > Security settings > API token
backend_url = "MY_PELIQAN_URL"   # optional, default: https://app.eu.peliqan.io/

pq = Peliqan(jwt, backend_url)

# Example usage
dbconn = pq.dbconnect('dw_xxx') # Enter the name of your Peliqan data warehouse
data = dbconn.fetch('dw_xxx', 'schema_name', 'table_name')
print(data)

df = dbconn.fetch('db_name', 'schema_name', 'table_name', df=True)
print(df)

$ pip install streamlit

if 'RUN_CONTEXT' in globals(): # Running on Peliqan
    RUN_ENV = 'peliqan'
else: # Running outside of Peliqan
    RUN_ENV = 'local'
    from peliqan import Peliqan
    import streamlit as st
    import os
    api_key = os.getenv("PELIQAN_API_KEY")
    if not api_key:
        st.error("PELIQAN_API_KEY environment variable is not set.")
        st.stop()
    interface_id = os.getenv("PELIQAN_INTERFACE_ID", 0) # script id in Peliqan, used to share state (see below)
    pq = Peliqan(api_key)
    try: # Check if running locally in Streamlit
        from streamlit.runtime.scriptrunner import get_script_run_ctx
        if get_script_run_ctx() is not None:
            RUN_CONTEXT = "interactive"
    except Exception:
        RUN_CONTEXT = "background"

# Your data app code goes here

def get_state():
    if RUN_ENV == 'local': # Running outside of Peliqan
        url = f"{pq.BACKEND_URL}/api/interfaces/{interface_id}/state/"
        result = pq.__service_client__.call_backend(method="get", url=url, expected_status_code=200)
        state = result["state"]
        return state
    else:
        return pq.get_state()

def set_state(state):
    if RUN_ENV == 'local': # Running outside of Peliqan
        url = f"{pq.BACKEND_URL}/api/interfaces/{interface_id}/state/"
        payload = {"state": state}
        result = pq.__service_client__.call_backend(method="post", url=url, json=payload, expected_status_code=200)
        return result
    else:
        return pq.set_state(state)

state = get_state()

from peliqan import Peliqan

jwt = "..." # Get from env variable
pq = Peliqan(jwt)

group_id = 123  # See Peliqan > Admin > Groups

with open("my_data_app.py", "r") as f:
    raw_script = f.read()

# Update an existing data app
result = pq.update_script(script_id = 1234, raw_script = raw_script)
print(result)

# Deploy a new data app
result = pq.add_script(
        group_id = group_id, 
        group_name = 'Production data', 
        raw_script = raw_script, 
        name = 'My newly deployed data app'
    )
print(result)