Skip to main content
Ctrl+K

Safir

  • User guide
  • API reference
  • Change log
  • Development guide
  • Rubin docs
  • GitHub
  • User guide
  • API reference
  • Change log
  • Development guide
  • Rubin docs
  • GitHub

Section Navigation

Tutorials

  • Creating an app from the template

Guides

  • Logging in Safir applications
  • Using the HTTPX client
  • Using the database API
    • Initializing a database
    • Using a database session in request handlers
    • Creating a database session
    • Handling datetimes in database tables
    • Retrying database transactions
    • Paginated queries
    • Testing applications that use a database
    • Managing schemas
  • Using the arq Redis queue client and dependency
  • Requiring Gafaelfawr authentication
  • Handling X-Forwarded-* headers
  • IVOA protocol support
  • Integrating with Kafka
    • Kafka connection settings
    • Managing schema registry schemas with Pydantic Models
    • Testing with Kafka
  • Using the Kubernetes API
  • Application metrics
  • Utilities for Pydantic models
  • Storing Pydantic objects in Redis
  • Using the Google Cloud Storage API
  • Handling HTTP errors with FastAPI
  • datetime handling
  • Starting an app with Uvicorn for testing
  • Sending messages and alerts to a Slack webhook
  • Building GitHub integrations
    • Creating clients with GitHubAppClientFactory
    • Handling GitHub webhooks
    • GitHub API resource models
    • Models for GitHub webhook payloads
  • Using Click for command-line interfaces
  • Using the asyncio multiple-reader queue
  • Building UWS applications
    • Creating a new UWS service
    • Define job parameter models
    • Defining service inputs
    • Write the backend worker
    • Testing UWS applications
  • Integrating Sentry
  • User guide

User guide#

Tutorials

  • Creating an app from the template

Guides

  • Logging in Safir applications
  • Using the HTTPX client
  • Using the database API
  • Using the arq Redis queue client and dependency
  • Requiring Gafaelfawr authentication
  • Handling X-Forwarded-* headers
  • IVOA protocol support
  • Integrating with Kafka
  • Using the Kubernetes API
  • Application metrics
  • Utilities for Pydantic models
  • Storing Pydantic objects in Redis
  • Using the Google Cloud Storage API
  • Handling HTTP errors with FastAPI
  • datetime handling
  • Starting an app with Uvicorn for testing
  • Sending messages and alerts to a Slack webhook
  • Building GitHub integrations
  • Using Click for command-line interfaces
  • Using the asyncio multiple-reader queue
  • Building UWS applications
  • Integrating Sentry

previous

Safir

next

Creating an app from the template

© Copyright 2020-2024 Association of Universities for Research in Astronomy, Inc. (AURA).

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.