ModelKG SDK Maintenance
Overview
Keep modelkg_common consistent and ensure all services adopt changes safely.
Use When
- •Adding or changing shared errors, middleware, logging, request context, health, or HTTP helpers.
- •Updating shared settings or environment variable handling.
- •Introducing new shared dependencies used by multiple services.
Workflow
- •Review the SDK change in
modelkg_common/and confirm the intended API. - •Find all services that import or depend on the touched module(s).
- •Update imports and usage sites across services.
- •Update dependencies (requirements/pyproject) where needed.
- •Update service configuration or environment variables if behavior changed.
- •Add or update tests to cover new SDK behavior in at least one service.
- •Run the smallest relevant test set and fix any regressions.
- •If API contracts change, refresh
docs/openapi/modelkg-openapi.json.
Safety Checks
- •No circular imports introduced in
modelkg_common. - •Services still start with the updated shared module.
- •Logging and error responses remain consistent.
References
- •
modelkg_common/README.md - •
modelkg_common/errors.py - •
modelkg_common/logging.py - •
modelkg_common/middleware.py - •
modelkg_common/http.py - •
modelkg_common/health.py