keboola-streamlit 0.0.1

Keboola Streamlit simplifies the use of Keboola Storage API within Streamlit apps, providing easy-to-use functions for authentication, data retrieval, event logging, and data loading.

KeboolaStreamlit

KeboolaStreamlit is a Python package that facilitates the integration of Streamlit applications with the Keboola Storage API. It provides various functionalities for authentication, data retrieval, event creation, and data loading in a Keboola environment.

Installation

To install KeboolaStreamlit, you can use pip:

pip install keboola-streamlit

Usage

Initialization

Create an instance of the KeboolaStreamlit class with the required parameters:

from keboola_streamlit import KeboolaStreamlit

keboola = KeboolaStreamlit(root_url='https://connection.keboola.com', token='YOUR_API_TOKEN')

Authentication Check

Ensure that the user is authenticated and authorized to access the Streamlit app:

keboola.auth_check(required_role_id='YOUR_REQUIRED_ROLE_ID')

Retrieve Data

Fetch data from a Keboola Storage table and return it as a Pandas DataFrame:

df = keboola.get_data(table_id='YOUR_TABLE_ID')

Load Data

Load data from a Pandas DataFrame into a Keboola Storage table:

keboola.load_data(table_id='YOUR_TABLE_ID', df=your_dataframe, is_incremental=False)

Create Event

Create an event in Keboola Storage to log activities:

keboola.create_event(message='Your event message')

Add Keboola Table Selection

Add a Keboola table selection form to your Streamlit app sidebar:

selected_table_data = keboola.add_keboola_table_selection()

License

This project is licensed under the MIT License. See the LICENSE file for more details.