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 database API
  • Initializing a database
  • Using a database session in request handlers
  • Handling datetimes in database tables
  • Testing applications that use a database
  • Less-used database operations
• Using the httpx client
  • Setting up the httpx.AsyncClient
  • Using the httpx.AsyncClient
  • Testing considerations
• Requiring Gafaelfawr authentication
  • Getting the authenticated user
  • Including the authenticated user in logging
  • Testing applications using this dependency
• Using the Kubernetes API
  • Initializing Kubernetes
  • Testing with mock Kubernetes
• 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
• IVOA protocol support
  • Query parameter case insensitivity

API

• API reference
  • safir Package
  • safir.database Module
  • safir.dependencies.db_session Module
  • safir.dependencies.gafaelfawr Module
  • safir.dependencies.http_client Module
  • safir.dependencies.logger Module
  • safir.kubernetes Module
  • safir.logging Module
  • safir.metadata Module
  • safir.models Module
  • safir.middleware.ivoa Module
  • safir.middleware.x_forwarded Module
  • safir.testing.kubernetes Module

Development guide

• Development guide
• Release procedure

Indices

• Index

• Module Index

• Search Page