Financial Chat

https://github.com/wshobson/financial-chat
Admin
A financial chat application powered by LangChain, LangGraph, OpenBB, Claude 3 Opus, and Streamlit...
Tokens:1,034
Snippets:7
Trust Score:9.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Dependencies

Source: https://github.com/wshobson/financial-chat/blob/main/README.md

Installs the required project dependencies using Poetry. This command ensures all necessary libraries are downloaded and configured for the project.

```bash
poetry install
```

--------------------------------

### Start FastAPI Server

Source: https://github.com/wshobson/financial-chat/blob/main/README.md

Launches the FastAPI server, which serves the application's API endpoints. This server is used for backend operations and can be accessed via HTTP.

```bash
uvicorn app.server:app --host 0.0.0.0 --port 8080
```

--------------------------------

### Environment Variables Setup

Source: https://github.com/wshobson/financial-chat/blob/main/README.md

Sets up essential environment variables for the application. These variables include API keys for services like OpenAI, OpenBB, Tiingo, Imgur, FMP, and Intrinio, which are crucial for data fetching and AI model interaction.

```bash
export OPENAI_API_KEY=<your-api-key>
export OPENBB_TOKEN=<your-openbb-token>
export TIINGO_API_KEY=<your-tiingo-api-key>
export IMGUR_CLIENT_ID=<your-imgur-client-id>
export IMGUR_CLIENT_SECRET=<your-imgur-client-secret>
export FMP_API_KEY=<fmp-api-key>
export INTRINIO_API_KEY=<intrinio-api-key>
```

--------------------------------

### Run Streamlit UI

Source: https://github.com/wshobson/financial-chat/blob/main/README.md

Starts the Streamlit application, providing an interactive user interface for the financial chat functionality. This is the primary way to interact with the application's features.

```bash
streamlit run app/ui.py
```

--------------------------------

### Build Docker Image

Source: https://github.com/wshobson/financial-chat/blob/main/README.md

Builds a Docker image for the financial-chat application. This image can then be used to containerize and deploy the application.

```bash
docker build -t financial-chat .
```

--------------------------------

### FastAPI Swagger Docs and Playground

Source: https://github.com/wshobson/financial-chat/blob/main/README.md

Provides access to the automatically generated Swagger UI documentation and a chat playground for the FastAPI server. These are useful for testing and understanding the API.

```bash
View Swagger Docs: http://0.0.0.0:8080/docs
View Playground: http://0.0.0.0:8080/chat/playground
```

--------------------------------

### Run Docker Container

Source: https://github.com/wshobson/financial-chat/blob/main/README.md

Runs the financial-chat application as a Docker container. It maps the container's port 8080 to the host machine and uses environment variables from a .env file.

```bash
docker run -p 8080:8080 --env-file .env financial-chat
```
Tokens:
Raw