How meaningfy-ws/mapping-suite-sdk works
Project Type and Purpose
• The project is an SDK (Software Development Kit) built for working with “Mapping Suites”. It focuses on the re-use of mapping suites (described as ZIP archive files with a specific folder structure) within transformation pipelines.
• There are two main use case perspectives mentioned in the README—one for a “UserModel” in a pipeline and one for a “DeveloperModel” in an editor. Although the current focus is on re-use, this hints at a separation in concerns between runtime usage and development.
File Structure
• Top-Level Components:
– The project root includes CI/CD configurations (.github/workflows), testing setup (tests), documentation (docs), and packaging scripts (Makefile, pyproject.toml, requirements.txt).
• Core Library Structure (located in the “mapping_suite_sdk” directory):
– Adapters: Contains modules like extractor.py, loader.py, and serialiser.py. These are responsible for handling input (extracting data from archives) and output (serialising mapping packages).
– Models: Consists of domain entities such as asset.py, core.py, and mapping_package.py. These files define the structure and relationships of the mapping suite domain.
– Services: Contains orchestration logic (e.g., load_mapping_package.py and serialise_mapping_package.py) that tie adapters and models together.
• Testing: The tests directory includes unit tests for both adapters and services and contains sample mapping package archives for test data.
• Documentation: The docs folder (with Antora configuration) is used to generate module-based documentation, which helps others understand the usage and structure of the SDK.
Elements
• Clear Labels: Each component (e.g., “Adapters”, “Models”, “Services”, “Mapping Package Archive”, and “Client / Pipeline”).