How artefactual-labs/aipscan works
Main Components
a. Frontend Layer:
• Web Interface (Flask templates in /templates)
• Static Assets (CSS/JS in /static)
• Report Visualizations
b. Backend Components:
• Flask Application Server
• Celery Worker System
• RabbitMQ Message Broker
• Database Layer (SQLite/MySQL)
• Optional Typesense Search Engine
c. External Systems:
• Archivematica Storage Service
• Archivematica AIP Storage
Component Relationships
[Web Browser] <-> [Flask App Server]
• [Database]
• [Typesense] (optional)
• [RabbitMQ] <-> [Celery Workers]
• v
[Archivematica Storage Service] <-> [AIP METS Files]
Module Organization
• API Module (/API): REST endpoints
• Aggregator Module (/Aggregator): AIP fetching and processing
• Reporter Module (/Reporter): Report generation
• Data Module (/Data): Data access layer
• User Module (/User): User management
Key Technical Details
• Port numbers (5000 for Flask, 5672 for RabbitMQ, 15672 for RabbitMQ admin)
• API endpoints
• Database connections
• Celery task queue
• Typesense integration points
Deployment Context
Optional deployment configurations:
• Development setup
• Docker-based deployment
• Production setup with MySQL
Reporting workflow
Keep the abstraction level high enough to show system architecture while including sufficient detail about the unique aspects of AIPscan, such as its METS file processing and reporting capabilities.