Skip to content

README.md

Latest commit

 

History

History
95 lines (79 loc) · 2.78 KB

README.md

File metadata and controls

95 lines (79 loc) · 2.78 KB

Travel Planner 🗺️

Travel Planner is a personal trip organization tool designed to help users efficiently plan, manage, and analyze their travels. From itinerary planning to budgeting and data visualization, Travel Planner makes travel preparation easier and more fun.

✈️ Overview & Features

🗓️ Trip Details & Itinerary

  • Input trip details (destination, dates, transportation, accommodation, activities)
  • Organize your trip schedule to stay on top of every detail.

💰 Budget Management

  • Track and manage the travel budget (giving the initial total budget, return the remaining budget)
  • Get budget recommendations to help you stay within limits.

📊 Data Visualization & Trip Analysis

  • Visualize travel data, e.g., visualization of the budget divided by categories and destination is provided

The app currently has a graphical user interface (GUI) built with Tkinter.

Requirements

  • Python 3.9+ (tested on Python 3.11)

  • Tkinter (comes pre-installed with most Python versions, library for creating graphical user interfaces (GUIs)). Ttk is part of this package and doesn't need to be installed

  • Webbrowser (built-in Python module for opening web pages - HTML files)

  • Os (built-in Python module)

  • Geopy (library used for geocoding)

  • Folium (library used for creating interactive maps)

  • Tkcalendar (library for adding calendars to tkinter interfaces)

  • Plotly (library for creating interactive visualizations)

    pip install numpy pandas geopy folium tkcalendar plotly

    or

    pip install -r requirements.txt

📁 Project Structure

├── README.md
├── ROADMAP.md
├── LICENSE
├── CHANGES.md
├── FORMATTER.md
├── destination_map.html 
├── budget_repartition.html
├── exception.md
├── testing.md
├── members.txt
├── requirements.txt
src/
 ├── main.py 
 ├── trip.py
 ├── __init__.py
 ├── travel_planner_app.py
 ├── tests.py

🌍 Destination_map.html displays a world map showing the input destination
💸 Budget_repartition.html displays how the budget is distributed by category

🚀 How to Run

  1. Open a terminal or command line.

  2. Navigate to the Travel-Planner/ directory.

  3. Create a virtual environment:

    python -m venv env

  4. Activate the virtual environment:

    • On Windows: 
      .\env\Scripts\activate
    • On macOS/Linux: 
      source env/bin/activate

  5. Install dependencies:

    pip install -r requirements.txt

  6. Run the main file:

    python -m scr.travel_planner_app

🧑‍💻 Members of the project

  • Evin Capan
  • Janosch Imhof
  • Mathilde Jacquey
  • Florence Kurz