Namude_Yatra / README.md
AdithyaSNair's picture
Update README.md
90f21b0 verified

A newer version of the Streamlit SDK is available: 1.45.1

Upgrade
metadata
title: Namude Yatra
emoji: 
colorFrom: green
colorTo: indigo
sdk: streamlit
sdk_version: 1.43.2
app_file: app.py
pinned: false
short_description: An AI Agentic Travel App

Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

Namude Yatra: The Beginning of Your Dream Journey

Namude Yatra is an AI-powered travel itinerary generator that creates personalized travel plans based on your preferences. Leveraging advanced language models and an intuitive Streamlit interface, this project helps you plan every aspect of your trip—from destination research and accommodation recommendations to activities, transportation, and dining experiences.


Table of Contents


Features

  • Dynamic Itinerary Generation:
    Create detailed day-by-day travel itineraries using specialized AI agents.

  • Multi-Agent System:
    Dedicated agents manage destination research, accommodations, transportation, activities, dining, and itinerary integration.

  • Interactive Web Interface:
    A Streamlit-based UI collects travel details, displays live progress, maps, and even provides a chatbot interface.

  • Dynamic API Key Input:
    Provide your GEMINI API key at runtime through the sidebar—no need to commit sensitive keys in a .env file.

  • Download & Share:
    Download your personalized itinerary as a text file, with plans for additional sharing features in future updates.

  • Integrated Map Visualization:
    View your destination on an interactive map powered by Pydeck.

  • Chatbot Interaction:
    Engage with an AI chatbot for real-time travel advice and assistance.


Project Directory Structure

Namude_Yatra/
├── app.py              # Main Streamlit app (UI, form inputs, itinerary display)
├── travel.py           # Core backend logic (LLM setup, AI agents, itinerary generation)
├── image.png           # Logo/banner image used in UI
├── requirements.txt    # List of dependencies
├── .gitignore          # Specifies files/folders to ignore in version control
├── README.md           # Project documentation
└── __pycache__/        # Auto-generated compiled Python files (ignored in version control)

Detailed Explanation of Key Files

File/Folder Description
app.py The main application file using Streamlit. It collects user inputs (including API key, travel details, etc.), displays progress, manages various tabs (itinerary, details, map, chatbot), and calls functions from travel.py.
travel.py Contains the backend logic for itinerary generation. It defines custom classes like Agent and Task, sets up the language model dynamically via an initialization function (init_travel_system(api_key)), and implements all the task execution functions.
image.png The logo or banner image used for branding in the sidebar and header of the app.
requirements.txt A list of all dependencies required by the project (e.g., Streamlit, LangChain, Google Generative AI SDK, geopy, pydeck, qrcode).
.gitignore Prevents sensitive and unnecessary files (like API keys, temporary files, and caches) from being pushed to version control.
README.md This documentation file describing the project, features, structure, and contact information.
pycache/ Directory for compiled Python files, which speeds up app execution. Not needed for version control.

Suggested Future Folders

To further enhance and organize the project, you may consider adding these folders:

  • assets/

    • Purpose: Store static assets such as additional images, icons, or fonts.
  • prompts/

    • Purpose: Keep custom prompt templates for the AI agents. This allows for easy modifications and versioning of prompts.
  • styles/

    • Purpose: Maintain external CSS files or style configurations to further customize the UI.
  • utils/

    • Purpose: Store helper scripts and utility functions (e.g., for data validation, formatting, logging enhancements).
  • docs/

    • Purpose: Additional technical documentation, API references, and user guides.

Contact

For any questions, feedback, or support, please contact:
Email: [email protected]


License

This project is open source and available under the MIT License.


Enjoy planning your dream journey with Namude Yatra! 🚀