Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.8 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.8 KB

Retirement Calculator 🚀💰💵🏖️

A Streamlit application for calculating retirement savings. This application allows users to input their current age, retirement age, current savings, annual savings, estimated annual return, and target savings to calculate their estimated savings at retirement age, any shortfall or overage, suggestions for adjusting annual savings, and progress towards the target savings.

Screenshot of the Retirement Calculator

Features

  • Input fields for current age, retirement age, current savings, annual savings, estimated annual return, and target savings.
  • Calculates estimated savings at retirement age.
  • Provides shortfall or overage between estimated savings and target savings.
  • Suggests how much to increase or decrease annual savings to reach target savings.
  • Indicates progress towards target savings.

Requirements

  • Python 3.8+
  • Poetry
  • Streamlit

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/retirement_calculator.git
    cd retirement_calculator
  2. Install the dependencies using Poetry:

    poetry install

Usage

  1. Run the Streamlit application:

    poetry run streamlit run retirement_calculator.py
  2. Open your web browser and navigate to http://localhost:8501 to use the application.

Project Structure

retirement_calculator/
├── functions.py
├── poetry.lock
├── pyproject.toml
└── retirement_calculator.py
  • functions.py: Contains the non-Streamlit functions for calculating savings and adjustments.
  • retirement_calculator.py: Main Streamlit application file.
  • pyproject.toml: Poetry configuration file.
  • poetry.lock: Poetry lock file.

License

This project is licensed under the MIT License.