Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.44 KB

README.md

File metadata and controls

63 lines (42 loc) · 2.44 KB

Weather API Wrapper

License: MIT Python Version from PEP 621 TOML FastAPI Polars Redis Pre-commit Docker Ruff Checked with mypy

Overview

This project is a weather API wrapper that fetches weather data for a specified city. It uses FastAPI for the web framework, Polars for data manipulation, and integrates with external APIs to get weather forecasts and location data.

Features

  • Fetch weather data for a city.
  • Cache weather data to improve performance.
  • Display weather data using a web interface.

Installation

  1. Clone the repository:

    git clone https://github.com/marcelogcardozo/weather-app.git
cd weather-app

  2. Create a virtual environment and activate it:

    python -m venv .venv
source .venv/bin/activate  # On Windows use `venv\Scripts\activate`

  3. Install the required dependencies:

    pip install -r requirements.txt

Running the Application

Create a .env file with your API keys and preferred redis settings based on the provided .env.example file.

  1. Start the FastAPI server:

    fastapi run src/app/main.py

  2. Open your browser and navigate to http://127.0.0.1:8000 to access the web interface.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

License

This project is licensed under the MIT License.