dharmatech-openbb

A custom OpenBB backend providing Treasury and Federal Reserve data visualizations.

You can add it on OpenBB by copy-pasting this link ot the workspace: https://dharmatech-openbb.fly.dev

Prerequisites

• Python 3.8+
• Docker (optional, for containerized deployment)

Local Development Setup

1. Clone the repository:

git clone https://github.com/yourusername/dharmatech-openbb.git
cd dharmatech-openbb

2. Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies:

pip install -r requirements.txt

4. Run the application:

uvicorn main:app --port 5050

The application will be available at http://localhost:5050

Docker Setup

1. Build the Docker image:

docker build -t dharmatech-openbb .

2. Run the container:

docker run -p 5050:5050 dharmatech-openbb

Deployment to Fly.io

1. Install the Fly CLI:

curl -L https://fly.io/install.sh | sh

2. Login to Fly:

fly auth login

3. Launch the application:

fly launch

4. Deploy:

fly deploy

Available Endpoints

• /widgets.json - List of available widgets
• /templates.json - Widget templates
• /transactions - Treasury transactions data
• /fed-net-liquidity - Federal Reserve net liquidity metrics
• /fed-balance-sheet - Federal Reserve balance sheet data
• /mts-income-taxes-monthly - Monthly income tax receipts
• And more...

Development

To add new widgets or modify existing ones, edit the main.py file and follow the existing patterns for widget registration and endpoint implementation.