Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions interactive_examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,27 @@ python instrument_search/search_equity.py --token <TOKEN> --query RELIANCE

---


## 🚀 Try it Online

A Streamlit web app wraps every example with a UI — paste your token and run:

> **[▶ Open Live App](https://upstox-python-examples.streamlit.app)** *(coming soon — deploy steps below)*

Or run locally:

```bash
git clone https://github.com/upstox/python-examples
cd python-examples
pip install -r requirements.txt
streamlit run streamlit_app.py
```

---




## Getting a Token

| Token | How to get | Valid for | Can trade? |
Expand Down Expand Up @@ -204,6 +225,27 @@ python market_data/live_depth_mcx.py --token <TOKEN> # Ctrl-C to stop

---


## 🌐 Deploy the Streamlit App

The `streamlit_app.py` wraps all 39 examples in a browser UI with interactive inputs and charts.

### Streamlit Cloud (free, ~5 minutes)

1. Fork / push this repo to GitHub
2. Go to [share.streamlit.io](https://share.streamlit.io) → **New streamlit_app**
3. Select this repo, branch `main`, file `streamlit_app.py`
4. Click **Deploy** — you get a shareable URL instantly

### Run locally

```bash
pip install -r requirements.txt
streamlit run streamlit_app.py
```

---

## Project Structure

```
Expand Down
Loading
Loading