{"id":19839613,"url":"https://github.com/dataherald/streamlit-app","last_synced_at":"2025-10-27T20:36:12.981Z","repository":{"id":194790210,"uuid":"691585848","full_name":"Dataherald/streamlit-app","owner":"Dataherald","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-03T16:55:58.000Z","size":219,"stargazers_count":16,"open_issues_count":0,"forks_count":20,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-06T17:05:13.991Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Dataherald.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-14T13:30:33.000Z","updated_at":"2024-11-07T21:48:48.000Z","dependencies_parsed_at":"2023-09-28T19:14:20.474Z","dependency_job_id":"62c2ddab-4e1d-414b-8a85-6b169361c8a7","html_url":"https://github.com/Dataherald/streamlit-app","commit_stats":null,"previous_names":["dataherald/streamlit-app"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dataherald%2Fstreamlit-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dataherald%2Fstreamlit-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dataherald%2Fstreamlit-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dataherald%2Fstreamlit-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dataherald","download_url":"https://codeload.github.com/Dataherald/streamlit-app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251932520,"owners_count":21667157,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T12:23:30.944Z","updated_at":"2025-10-27T20:36:12.853Z","avatar_url":"https://github.com/Dataherald.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dataherald Community App 🛠️\n\nWelcome to the Dataherald Community App! This Streamlit-based web application allows users to interact with the Dataherald engine through a user-friendly interface, making it easier to work with your structured data. 🔥🔥🔥\n\n![Dataherald Logo](./images/dataherald.png)\n\n## Table of Contents 📚\n\n- [Features](#features) 🚀\n- [Prerequisites](#prerequisites) ⚙️\n- [Installation](#installation) 🚀\n- [Usage](#usage) 📈\n- [How it works?](#how) 🧐\n- [Contributions](#contribution) 🤝\n\n\n## Features 🚀\n\n- **Ask your Questions:** 💡 Connect to various databases by providing their connection details and ask any questions that have on top of your mind from Dataherald's powerful NL-to-SQL engine.\n\n- **Add Golden records:** 💎 In order to boost the performance of the engine even higher, add verified Question/SQL pairs. These pairs are going to be used by the agent at inference time.\n\n- **View and Remove Golden records:** 📜 This application provides a user-friendly interface for viewing, searching, and removing Question/SQL pairs to control the agent's behavior.\n\n- **Table Scanning:** 🗃️ Scan tables in connected databases by specifying the table name. Scanned tables are used by the agent to generate answers.\n\n- **Viewing Tables:** 📊 View descriptions and details of tables within connected databases. Understand the structure and number of columns of each table easily.\n\n## Prerequisites ⚙️\n\nBefore running Dataherald, ensure that you have the following prerequisites:\n\n- **Dataherald engine:** 💻 Make sure you have Dataherald engine running since this application calls the endpoints provided by the Dataherald engine.\n\n- **Python 3.x:** 🐍 Make sure you have Python 3.x installed on your system. You can download it from the [official Python website](https://www.python.org/downloads/).\n\n## Installation 🚀\n\nTo get started with Dataherald, follow these steps:\n\n1. **Clone the repository to your local machine:**\n\n   ```shell\n   git clone https://github.com/Dataherald/streamlit-app.git\n   cd streamlit-app\n\n2. **Create a virtual environment (optional but recommended):**\n\n    ```shell\n    python -m venv venv\n    source venv/bin/activate  # On Windows, use `venv\\Scripts\\activate`\n    ```\n\n3. **Install required packages: 📦 This app relies on several Python packages. Install them by running the following command within the project directory:**\n\n    ```shell\n    pip install -r requirements.txt\n    ```\n\n## Usage 📈\nTo use Dataherald Community App and interact with databases, follow these steps:\n\nChange the following code parts based on your current implementation of Dataherald engine:\n```python\nDEFAULT_DATABASE = \"RealEstate\" # change this to your default database\nHOST = st.sidebar.text_input(\"Engine URI\", value=\"https://streamlit.dataherald.ai\") #change the value to your localhost or server URI where your engine is deployed\n```\n\nStart the Dataherald Community App application:\n\n``` shell\nstreamlit run 🏠_Home.py\n```\n\n## How it Works 🧐\nIf you want to know how the app works, you can take a look at the following figure:\n\n![Architecture](./images/architecture.png)\n\n## Contributions 🤝\nWe are extremely open to contributions, be it through new features, new pages, or improved documentation.\n\nWe are currently developing this repository, you can take a look at the roadmap we have for this app, and we will appreciate your contribution for the future works that we have. You can find the roadmap [here](https://github.com/Dataherald/streamlit-app/blob/main/contributions.md#roadmap-%EF%B8%8F).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdataherald%2Fstreamlit-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdataherald%2Fstreamlit-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdataherald%2Fstreamlit-app/lists"}