MSN Weather Wrapper Documentation

Modern Python wrapper for MSN Weather with a FastAPI backend, React frontend, and production-ready containerized deployment.

---

Quick Navigation

🚀 Getting Started

• Installation & Setup - Get up and running
• Quick Start Guide - Deploy in minutes
• Usage Examples - Python library and API usage

👨‍💻 Development

• Development Guide - Complete development workflow
• Container Development - Podman-based dev environment
• Testing Guide - Test suite, coverage, and best practices
• Versioning Guide - Semantic versioning and release process
• DevSecOps Monitor - Local + CI/CD RAG dashboard

📚 API & Features

• API Reference - Complete REST API documentation
• Interactive API Docs - Swagger UI for live API exploration
• Security - Security features, testing, and best practices

🚀 Deployment & Operations

• Container Setup - Production deployment
• SBOM Generation - Software bill of materials
• PyPI Setup - Automated PyPI publishing

📊 Project Information

• Changelog - Version history and updates
• Reports - Automated CI/CD reports
• Contributing - Contribution guidelines

---

Documentation Structure

Core Documentation

Document	Purpose	Audience
index.md	Documentation hub & navigation	Everyone
API.md	REST API reference	API Users
DEVELOPMENT.md	Development workflow	Contributors
SECURITY.md	Security features & testing	Security Teams
TESTING.md	Test suite documentation	Developers

Specialized Guides

Document	Purpose	Audience
CONTAINER_DEV_SETUP.md	Containerized development	Developers
MONITOR_DASHBOARD.md	DevSecOps monitor & RAG thresholds	DevSecOps/Developers
SYFT_GUIDE.md	SBOM generation	DevOps/Security
VERSIONING.md	Release process	Maintainers
PYPI_SETUP.md	PyPI publishing configuration	Maintainers

Reports & Logs

Document	Purpose	Audience
reports/index.md	CI/CD reports hub	DevOps
CHANGELOG.md	Version history	Everyone

---

Features at a Glance

Feature	Description	Documentation
🐍 Python Library	Type-safe weather client	Usage
🌐 REST API	FastAPI with typed validation and OpenAPI docs	API Docs
📖 Swagger UI	Interactive API documentation	Interactive Docs
⚛️ Next.js Frontend	Next.js 16, React 19 + TypeScript 6	Frontend
🐳 Containerized	Podman deployment	Container Dev
✅ Tested	168 tests (128 backend, 40 frontend), 97% coverage	Testing
🔒 Secure	Enhanced security scanning	Security
📋 SBOM	Supply chain security	SBOM Guide

---

Technology Stack

• Backend: Python 3.10+, FastAPI, Pydantic 2.12+, Uvicorn, Gunicorn 23.0+
• Frontend: Next.js 16, React 19.2, TypeScript 6+
• Testing: pytest 9.0+, Playwright, 168 tests
• Quality: ruff 0.14+, mypy 1.19+, pre-commit hooks
• Deployment: Podman/Docker, Nginx, multi-stage builds

---

Support & Resources

• 🐛 Report Issues
• 💬 Discussions
• 📖 Source Code
• 🎉 Releases

---