
Welcome to Resource Service
Resource Service is a FastAPI-based microservice designed for managing sustainability indicators through AI-generated data wrappers. It provides a comprehensive solution for collecting, processing, and distributing sustainability data from multiple sources including APIs, CSV files, and Excel spreadsheets.Quick Start
Get up and running in under 5 minutes with Docker Compose
Installation Guide
Detailed setup instructions for development and production environments
API Reference
Complete API documentation for all available endpoints
Core Concepts
Understand resources, wrappers, and data collection workflows
Key Features
AI-Powered Data Wrappers
AI-Powered Data Wrappers
Generate intelligent data collection wrappers using Google’s Gemini AI. The service automatically creates Python code to fetch and process sustainability indicator data from various sources.
Multi-Source Data Collection
Multi-Source Data Collection
Support for multiple data sources:
- API Integration: Connect to REST APIs with flexible authentication (Bearer, API Key, Basic Auth)
- CSV Files: Process uploaded CSV files with automatic validation
- Excel Spreadsheets: Handle XLSX files with preview and validation
Historical & Continuous Monitoring
Historical & Continuous Monitoring
Wrappers operate in two phases:
- Historical Phase: Collect all historical data from the source
- Continuous Phase: Monitor for new data points in real-time
Real-Time Health Monitoring
Real-Time Health Monitoring
Monitor wrapper execution with detailed health status, logs, and metrics:
- Process status tracking
- Execution logs with timestamps
- Data points count and timing information
- High/low water marks for data synchronization
Event-Driven Architecture
Event-Driven Architecture
Built on RabbitMQ for reliable message passing:
- Asynchronous wrapper generation
- Data point streaming to consumers
- Resource lifecycle events
- Scalable and decoupled architecture
Architecture Overview
The Resource Service is built with modern microservice patterns:FastAPI
High-performance async API framework with automatic OpenAPI documentation
MongoDB
Flexible document storage for resources, wrappers, and file metadata
RabbitMQ
Message broker for async operations and event streaming
Use Cases
Environmental Data Collection
Collect air quality, water quality, and climate data from government APIs and research databases.
Social Indicators
Aggregate social sustainability metrics from CSV reports and Excel spreadsheets provided by organizations.
Economic Metrics
Monitor economic indicators through continuous API polling with automatic data validation.
Technology Stack
What’s Next?
Get Started Now
Follow the quickstart guide to launch your first wrapper
Read the Installation Guide
Learn about detailed setup options and configuration
Prerequisites: Docker and Docker Compose are required. You’ll also need a Google Gemini API key for AI-powered wrapper generation.
