Python Services

Platform

Code style must be enforced using flake8.³

  [flake8]
  application-import-names = PACKAGE_NAME,tests
  exclude = build,env
  import-order-style = pycharm

sentry-sdk

  from sentry_sdk import init
  init(SENTRY_DSN)

The endpoint should be provide the following fields:

application: The name of the service
environment: The operating environment the instance of the service is running in (i.e. "development", "testing", "staging" or "production")
status: Current service status (e.g.: "ok", "starting")
version: Packaged version of the service instance
python_version: The python version running the service instance (platform.python_version()) The endpoint should return 200 when the service is healthy, and 503 if the service is not ready to serve requests.

An OpenAPI specification is hosted using ReDoc at the root service URL.⁴

json-scribe

json-problem

The service must include its name and version in its Server response header.⁵
The service must include its name and version in the User-Agent header for all its HTTP requests.⁶ Both of these should be presented as ${service-name}/${version}, e.g.: user-management/1.0.0.