msn-weather-wrapper 2.0.3

A production-ready Python wrapper for MSN Weather with a FastAPI backend and CI/CD

MSN Weather Wrapper

A modern, production-ready Python wrapper for MSN Weather with a FastAPI backend and React frontend.

---

Overview

MSN Weather Wrapper is a comprehensive weather data solution featuring:

• Python Library - Type-safe weather client with Pydantic models
• REST API - Production-ready FastAPI service with built-in OpenAPI docs
• Web Frontend - Modern React 19 + TypeScript 5.7+ with Vite 7
• Containerized - Podman/Docker deployment with Gunicorn, Uvicorn workers, and Nginx

Technology Stack:

• Backend: Python 3.10+, FastAPI 0.115+, Pydantic 2.12+, Uvicorn, Gunicorn 23.0+
• Frontend: React 19.2, Vite 7.2, TypeScript 5.7+
• Testing: pytest 8.0+, Playwright, 168 tests (128 backend, 40 frontend E2E) with 97% coverage
• Quality: ruff 0.14+, mypy 1.19+, pre-commit hooks
• Security: Bandit, Semgrep, pip-audit, Trivy, Grype, weekly automated scans
• Deployment: Podman/Docker, Nginx, multi-stage builds

---

Quick Start

🚀 Containerized Deployment (Recommended)

git clone https://github.com/jim-wyatt/msn-weather-wrapper.git
cd msn-weather-wrapper
podman-compose up -d
# Access at http://localhost:8080

📦 Python Package

pip install msn-weather-wrapper

from msn_weather_wrapper import WeatherClient, Location

with WeatherClient() as client:
    location = Location(city="London", country="UK")
    weather = client.get_weather(location)
    print(f"Temperature: {weather.temperature}°C")

🧪 Development Environment

./dev.sh setup   # One-time setup
./dev.sh start   # Start dev servers
./dev.sh status  # Check health
# Frontend: http://localhost:5173
# API: http://localhost:5000
# Health: http://localhost:5000/api/v1/health

🧭 Start Here If You're New

If you're learning the codebase, explore it in this order:

1. src/msn_weather_wrapper/ — backend logic and the FastAPI app
2. frontend/ — the React UI
3. tests/ — examples of expected behavior
4. scripts/ — helper commands for setup, reports, and deployment tasks

A detailed walkthrough now lives in docs/PROJECT_STRUCTURE.md.

---

Features

• 🌤️ Weather data extraction from MSN Weather
• 🌍 406+ cities worldwide with autocomplete
• 🔌 RESTful API with comprehensive validation
• 📚 Interactive API docs (Swagger UI at /apidocs/)
• ⚛️ Modern web interface with React + TypeScript
• 🚀 5-minute caching (90%+ faster repeated requests)
• 🔒 Rate limiting (30 req/min per IP, 200/hr global)
• 🛡️ Input validation & attack prevention (SQL injection, XSS, etc.)
• 🔐 Automated security scanning (Bandit, Semgrep, Trivy, Grype)
• 🔍 Type safety with mypy strict mode
• 📋 SBOM generation for supply chain security
• ♿ WCAG 2.1 Level AA accessible frontend
• 🔄 Modular CI/CD workflows - Reusable, maintainable architecture
• 🔄 Optimized CI/CD with Docker caching & conditional matrices
• 🏷️ Automated semantic versioning - Every PR auto-publishes to PyPI

---

Installation

Prerequisites

• Python 3.10+
• Node.js 20+ (for frontend development)
• Podman or Docker (for containerized deployment)

From Source

git clone https://github.com/jim-wyatt/msn-weather-wrapper.git
cd msn-weather-wrapper
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate
pip install -e ".[dev]"
pre-commit install

---

Usage

Python Library

from msn_weather_wrapper import WeatherClient, Location

with WeatherClient() as client:
    location = Location(city="Seattle", country="USA")
    weather = client.get_weather(location)

    print(f"Temperature: {weather.temperature}°C")
    print(f"Condition: {weather.condition}")
    print(f"Humidity: {weather.humidity}%")

REST API

# Development
python api.py

# Production
gunicorn -k uvicorn.workers.UvicornWorker --bind 0.0.0.0:5000 --workers 4 --timeout 120 api:app

# GET request
curl "http://localhost:5000/api/weather?city=London&country=UK"

# POST request
curl -X POST http://localhost:5000/api/weather \
  -H "Content-Type: application/json" \
  -d '{"city": "London", "country": "UK"}'

Web Frontend

cd frontend
npm install
npm run dev  # http://localhost:5173

Features: City autocomplete (406+ cities), temperature unit toggle (°C/°F), geolocation support, responsive design, WCAG 2.1 Level AA accessibility

---

Development

# Setup & Run
./dev.sh setup   # One-time setup
./dev.sh start   # Start dev environment
./dev.sh test    # Run tests
./dev.sh logs    # View logs

# Code Quality
ruff format .                    # Format
ruff check .                     # Lint
mypy src/msn_weather_wrapper     # Type check
pre-commit run --all-files       # Run all checks

# Testing
pytest                           # All tests
pytest --cov=src --cov-report=html  # With coverage
pytest tests/test_client.py -v   # Specific file

---

Deployment

# Podman/Docker Compose
podman-compose up -d
podman-compose logs -f
podman-compose down

# Standalone Container
podman build -t msn-weather-wrapper .
podman run -p 8080:80 msn-weather-wrapper

Architecture: Unified container (Python + Node.js), Nginx reverse proxy, Gunicorn with Uvicorn workers, and Kubernetes-ready health checks

---

Documentation

📚 Full Documentation

• API Reference - Complete REST API documentation
• Interactive Swagger UI - Live API testing & exploration
• Development Guide - Setup & development workflow
• Testing Guide - Test suite & coverage
• Security Guide - Security features & automated scanning
• SBOM Guide - Software bill of materials
• Changelog - Version history

---

Project Structure

msn-weather-wrapper/
├── src/msn_weather_wrapper/
│   ├── api/                    # FastAPI app (main, routers, services, schemas)
│   ├── client.py               # Core MSN weather client
│   ├── models.py               # Shared Pydantic models
│   └── exceptions.py           # Domain exceptions
├── frontend/                   # React application
├── tests/                      # Backend and integration tests
├── scripts/                    # Dev, reporting, and deployment helpers
├── infra/                      # Containers, compose files, and runtime config
├── docs/                       # Docs and beginner walkthroughs
├── api.py                      # Local API entrypoint
├── dev.sh                      # Thin wrapper around `scripts/dev.sh`
└── pyproject.toml              # Python project configuration

---

Contributing

Contributions are welcome! Please ensure:

1. ✅ All tests pass: pytest
2. 🎨 Code is formatted: ruff format .
3. 🔍 Type checks pass: mypy src/
4. 🪝 Pre-commit hooks pass
5. 📝 Documentation is updated

See CONTRIBUTING.md for detailed guidelines.

---

License

MIT License - see LICENSE for details.

---

Links

• 📖 Documentation
• 📦 PyPI Package
• 🐛 Issue Tracker
• 💬 Discussions

---

Disclaimer

This project is an unofficial wrapper for MSN Weather data and is provided for educational and personal use only. This software is not affiliated with, endorsed by, or officially connected to Microsoft Corporation or MSN Weather in any way.

---