Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pbv0/databricks-apps-cookbook
Ready-to-use code snippets for building interactive data applications using Databricks Apps.
https://github.com/pbv0/databricks-apps-cookbook
databricks web-application
Last synced: 20 days ago
JSON representation
Ready-to-use code snippets for building interactive data applications using Databricks Apps.
- Host: GitHub
- URL: https://github.com/pbv0/databricks-apps-cookbook
- Owner: pbv0
- License: mit-0
- Created: 2024-12-10T13:59:47.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-29T19:17:42.000Z (23 days ago)
- Last Synced: 2025-01-29T20:26:57.366Z (23 days ago)
- Topics: databricks, web-application
- Language: Python
- Homepage:
- Size: 871 KB
- Stars: 21
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# 📖 Databricks Apps Cookbook 🍳
Ready-to-use code snippets for building interactive data applications using [Databricks Apps](https://docs.databricks.com/en/dev-tools/databricks-apps/index.html).
* **10+ recipes for common use cases** such as reading and writing to and from tables and volumes, invoking traditional ML models and GenAI, or triggering workflows.
* **Try recipes in the Cookbook app** and simply copy a code snippet to build your own.
* **Description of requirements** (permissions, resources, dependencies) for each recipe.
* Deploy to Databricks Apps or run locally.
* Snippets use Streamlit components but can easily be adapted to other Python frameworks.
> [!WARNING]
> This code sample is experimental and not intended for production use. It is a personal project provided by the contributors and not by Databricks.
## Deploy to Databricks
1. [Fork this Git repository](https://docs.github.com/de/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) to your own GitHub account.
1. [Load the cloned repository as a Databricks Git folder](https://docs.databricks.com/en/repos/index.html) in your Databricks workspace.
1. In your Databricks workspace, switch to **Compute** -> **Apps**.
1. Choose **Create app**.
1. Under **Choose how to start**, select **Custom** and choose **Next**.
1. Provide a name for your app and choose **Create app**.
1. Once your app compute has started, choose **Deploy**.
1. Select your new Git folder and choose **Deploy**.
> [!IMPORTANT]
> Check the Requirements tab of each recipe to understand what [service principal permissions](https://docs.databricks.com/en/dev-tools/databricks-apps/app-development.html#configure-resources), Databricks resources, and Python packages are required to use it.
## Run locally
1. [Clone this repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) to your local machine and switch into the `databricks-apps-cookbook` folder:
```bash
git clone https://github.com/pbv0/databricks-apps-cookbook.git
cd databricks-apps-cookbook
```
1. Create and activate a Python virtual environment using [`venv`](https://docs.python.org/3/library/venv.html):
```bash
python3 -m venv .venv
source .venv/bin/activate
```
1. Install required packages:
```bash
pip install -r requirements.txt
```
1. Install the [Databricks CLI](https://docs.databricks.com/en/dev-tools/cli/index.html) and authenticate with your Databricks workspace using [OAuth U2M](https://docs.databricks.com/en/dev-tools/auth/oauth-u2m.html), for example:
```bash
databricks auth login --host https://my-workspace.cloud.databricks.com/
```
1. Set required environment variables:
```bash
export DATABRICKS_HOST=https://my-workspace.cloud.databricks.com/
```
1. Run the Cookbook app locally:
```bash
streamlit run app.py
```
> [!IMPORTANT]
> Make sure you have a working network connection to your Databricks workspace. Some samples may only work when running on Databricks Apps and not locally, e.g., retrieving information from HTTP headers to identify users.
## Contributions
We welcome contributions! Submit a [pull request](https://github.com/pbv0/databricks-apps-cookbook/pulls) to add or improve recipes. Check out the roadmap below for inspiration. Raise an [issue](https://github.com/pbv0/databricks-apps-cookbook/issues) to report a bug or raise a feature request.
## Roadmap / recipes wanted
- [ ] Genie Conversations API
- [ ] Embedding a dashboard