Safir

Safir is the SQuaRE Framework for Roundtable

Roundtable is the SQuaRE application and bot deployment platform, hosted on Kubernetes with Argo CD. Safir is a Python package that lets you develop Roundtable bots, based on the FastAPI asyncio web framework.

Safir is developed on GitHub at https://github.com/lsst-sqre/safir.

Getting started

• Change log

Tutorials

• Creating an app from the template

Guides

• Using the httpx client
  • Setting up the httpx.AsyncClient
  • Using the httpx.AsyncClient
  • Testing considerations
• Logging in Safir applications
  • How to set up logging for Safir-based applications
  • Logging in request handlers
  • Logging elsewhere in your application
• Handling X-Forwarded-* headers
  • Setting up XForwardedMiddleware
  • Using XForwardedMiddleware
  • Forwarded header

API

• API reference
  • safir Package
  • safir.dependencies.http_client Module
  • safir.dependencies.logger Module
  • safir.logging Module
  • safir.metadata Module
  • safir.models Module
  • safir.middleware.x_forwarded Module

Development guide

• Development guide
• Release procedure

Indices

• Index

• Module Index

• Search Page