From 71c2f5fbc5e656a0a4126a113f35ab26dace1502 Mon Sep 17 00:00:00 2001 From: Michael Feng Date: Thu, 27 Apr 2023 10:15:03 -0500 Subject: [PATCH 1/2] resolved conflicts --- .gitignore | 7 +-- README.md | 54 +++++++++++-------- .../3_\360\237\247\231_XE_Token_Analyzer.py" | 0 .../7_\360\237\223\213_Data.py" | 0 4 files changed, 36 insertions(+), 25 deletions(-) rename "pages/7_\360\237\247\231_XE_Token_Analyzer.py" => "pages/3_\360\237\247\231_XE_Token_Analyzer.py" (100%) rename "pages/3_\360\237\223\213_Data.py" => "pages/7_\360\237\223\213_Data.py" (100%) diff --git a/.gitignore b/.gitignore index f273143e..b45758ba 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,5 @@ # Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class +**/__pycache__/ # C extensions *. @@ -133,3 +131,6 @@ dmypy.json # Pyre type checker .pyre/ + +# Database +/data \ No newline at end of file diff --git a/README.md b/README.md index c15f9bc0..e53a166f 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,49 @@ -# Hummingbot StreamLit Apps +# Hummingbot Dashboards -Collection of Hummingbot-related data apps and dashboards, built using [StreamLit](https://streamlit.io/). +Collection of Hummingbot-related dashboards, built using [StreamLit](https://streamlit.io/). This repository is maintained by Hummingbot Foundation as a companion for users of [Hummingbot](https://github.com/hummingbot/hummingbot), the open source framework for building high-frequency crypto trading bots. -### Getting Started Video - +Watch this video to understand how it works: https://www.loom.com/share/72d05bcbaf4048a399e3f9247d756a63 -### Deployed Apps - +See an example of a live, deployed dashboard: https://hummingbot-streamlit-apps-main-jnja50.streamlit.app -## Current Data Apps +## Dashboards -Here are the current data apps in the collection: +Here are the current dashboards in the collection: -### XE Token Analyzer +### 🚀 Strategy Performance (WIP) -Visualize the bid-ask spread and volume of different tokens across the crypto exchange landscape. This app is most helpful for Hummingbot users running the [Cross-Exchange Market Making](https://hummingbot.org/strategies/cross-exchange-market-making/) and [Arbitrage](https://hummingbot.org/strategies/arbitrage/) strategies. +Dashboard that helps you analyze the performance of a running Hummingbot instance -### Hummingbot DB +### 🧙 XE Token Analyzer -Drop a SQLite trades file for a specific strategy configuration, so that you can inspect and analyze the trade data. +Dashboard that helps you visualize the bid-ask spread and volume of different tokens across the crypto exchange landscape. -### TVL vs MCAP Analysis +This app is most helpful for Hummingbot users running the [Cross-Exchange Market Making](https://hummingbot.org/strategies/cross-exchange-market-making/) and [Arbitrage](https://hummingbot.org/strategies/arbitrage/) strategies. -Easily compare various DeFi protocols based on their market capitalization and total value locked, using DeFiLlama data. +### 🧳 Hummingbot DB + +Inspect and analyze the orders and trades data contained in a SQLite database for a strategy or script. + +These files are located in the `/data` folder in Hummingbot, and are named `.sqlite`. + +### 🦉 TVL vs MCAP Analysis -**How to find**: These files are located in the `/data` folder in Hummingbot, and are named `.sqlite`. +Easily compare various DeFi protocols based on their market capitalization and total value locked, using DeFiLlama data. -### Data +### 📋 Data Reference data for the various apps this collection. ## Installation -1. Install Anaconda or Miniconda +1. Install [Anaconda](https://www.anaconda.com/) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html) 2. Clone this repo and navigate to the created directory -``` +```bash git clone https://github.com/hummingbot/streamlit-apps.git cd streamlit-apps ``` @@ -50,19 +54,25 @@ conda env create -f environment_conda.yml ``` 4. Activate the environment -``` +```bash conda activate streamlit-apps ``` 5. Run the app -``` +```bash streamlit run main.py ``` -For more info, see instructions located at https://docs.streamlit.io/library/get-started/installation. +6. Create a symlink to your Hummingbot `/data` directory +```bash +# replace `/path/to/hummingbot` with the actual path +ln -s /path/to/hummingbot/data data +``` + +For more info about Streamlit installation, see the instructions located at https://docs.streamlit.io/library/get-started/installation. ## Contributions We welcome new data apps, bug fixes, and improvements by the community! -To submit a contribution, issue a pull request and follow the general guidelines listed at https://hummingbot.org/developers/contributions. +To submit a contribution, issue a pull request, following the guidelines listed at https://hummingbot.org/developers/contributions. diff --git "a/pages/7_\360\237\247\231_XE_Token_Analyzer.py" "b/pages/3_\360\237\247\231_XE_Token_Analyzer.py" similarity index 100% rename from "pages/7_\360\237\247\231_XE_Token_Analyzer.py" rename to "pages/3_\360\237\247\231_XE_Token_Analyzer.py" diff --git "a/pages/3_\360\237\223\213_Data.py" "b/pages/7_\360\237\223\213_Data.py" similarity index 100% rename from "pages/3_\360\237\223\213_Data.py" rename to "pages/7_\360\237\223\213_Data.py" From a7552918cebb1604913abb96018a321912acd763 Mon Sep 17 00:00:00 2001 From: Michael Feng Date: Mon, 8 May 2023 19:52:13 -0700 Subject: [PATCH 2/2] fixes --- .gitignore | 4 +++- README.md | 8 ++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index b45758ba..6f8c0a1e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,7 @@ # Byte-compiled / optimized / DLL files -**/__pycache__/ +__pycache__/ +*.py[cod] +*$py.class # C extensions *. diff --git a/README.md b/README.md index e53a166f..7253d67c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Watch this video to understand how it works: https://www.loom.com/share/72d05bcbaf4048a399e3f9247d756a63 See an example of a live, deployed dashboard: -https://hummingbot-streamlit-apps-main-jnja50.streamlit.app +https://hummingbot-streamlit-app-main-jnja50.streamlit.app ## Dashboards @@ -44,8 +44,8 @@ Reference data for the various apps this collection. 2. Clone this repo and navigate to the created directory ```bash -git clone https://github.com/hummingbot/streamlit-apps.git -cd streamlit-apps +git clone https://github.com/hummingbot/dashboard.git +cd dashboard ``` 3. Run this command to create a `conda` environment and install dependencies @@ -55,7 +55,7 @@ conda env create -f environment_conda.yml 4. Activate the environment ```bash -conda activate streamlit-apps +conda activate dashboard ``` 5. Run the app