Apppublic

therickglenn/WarrenAI_Your_Intelligent_Wealth_Companion

sourceHugging Facemitupdated 2y agoView on Hugging Face

0likes

App README

`markdown

# Warren.AI – Your Intelligent Wealth Companion

Warren.AI is a Streamlit-powered application for financial tracking and insights. Inspired by Warren Buffett's approach to data-driven and long-term financial planning, Warren.AI helps users:

- Add and categorize financial transactions (income/expense)  
- Upload/Download CSV files for easy data import/export  
- Visualize financial metrics (net balance, recurring transactions, etc.)  
- Explore interactive charts (bar, line, and pie charts) to understand income vs. expense distribution  

---

## Demo on Hugging Face Spaces

If you're viewing this README on [Hugging Face Spaces](https://huggingface.co/spaces), you can click the **"App"** tab to launch the live Streamlit interface. Otherwise, please follow the steps below to run the app locally.

---

## Installation

1. **Clone or download** this repository:

git clone https://huggingface.co/spaces/your-username/warren-ai cd warren-ai


   **Install dependencies (listed in `requirements.txt`):**

pip install -r requirements.txt


   **Run the Streamlit app locally:**

streamlit run main.py

   
   Or replace `main.py` with the actual file name containing your script (e.g., `warren_ai_app.py`).

---

## Usage

Navigate to [http://localhost:8501](http://localhost:8501) in your web browser after running the command above.

**Sidebar Menu**: Use the sidebar to navigate between these main sections:
- **Home**: Overview of Warren.AI and instructions on how to use it
- **Add Transaction**: Manually add one-time or recurring transactions
- **View Transactions**: See a table of all recorded transactions
- **Upload Spreadsheet**: Import your own CSV of transactions
- **Download Spreadsheet**: Export your transactions as a CSV
- **Financial Overview**: Get key metrics and interactive charts

---

## Features

- **Recurring Transactions**: Easily schedule expenses or income that repeat daily, weekly, monthly, etc.
- **Auto-Summarize**: On the Financial Overview page, get real-time calculations of total income, total expenses, net balance, and more.
- **Interactive Charts**: View bar charts, line charts, and a pie chart (with a custom background) in one row for a holistic snapshot of your finances.

---

## Contributing

Feel free to open issues or submit pull requests if you have suggestions or want to add new features.

---

## License

This project is provided under the **MIT License** (or whichever license you prefer). Make sure to include a license file in the repo if you plan to release it publicly.

---

## Contact

For any questions or feedback, please reach out via **GitHub Issues** or the **Hugging Face Discussion tab**.

---

**Thank you for using Warren.AI!** We hope this tool helps you take charge of your finances confidently.