How seitabv/python-s2-protocol works
Main Components
a) Input Layer:
• S2-WS-JSON schemas source (s2-ws-json/s2-asyncapi/s2-cem.yaml)
• Different protocol modes (FRBC, DDBC, PEBC, PPBC)
b) Generation Layer:
• Datamodel-codegen tool component
• Model generation process
c) Library Structure:
• Common module (shared components)
• Protocol-specific modules (FRBC, etc.)
• Messages and Schemas separation
Component Relationships
[S2-WS-JSON Schema Files] --> [datamodel-codegen] --> [Generated Python Models]
• v
[Common Models] <---- [Protocol-Specific Models (FRBC, etc.)]
• ^ |
• v
[End User Applications] -----> [Message Handling]
Specific Elements
• Blue: External dependencies (datamodel-codegen)
• Green: Generated code
• Yellow: Core library components
• Gray: Common utilities and shared code
• Rectangles: Main components
Important Details to Highlight
• Separation between:
• Raw generated models
• Refactored/organized models
• Common utilities
• Protocol-specific implementations
Technical Specifications
A side panel showing:
• Python dependencies
• Generated model structure
• Key class hierarchies
• Integration points
Implementation Notes
Annotations indicating:
• Model generation process
• Manual refactoring steps
• Testing framework integration
• Installation process
Key Considerations: