Skip to main content

The Rubin Observatory SQuaRE framework for FastAPI services.

Project description

Safir

Safir is Rubin Observatory's library for building FastAPI services for the Rubin Science Platform (Phalanx) and Roundtable Kubernetes clusters. Safir is developed, maintained, and field tested by the SQuaRE team.

Safir is available from PyPI:

pip install safir

The best way to create a new FastAPI/Safir service is with the fastapi_safir_app template.

Read more about Safir at https://safir.lsst.io.

Features

  • Set up an httpx.AsyncClient as part of the application start-up and shutdown lifecycle.
  • Set up structlog-based logging.
  • Middleware for attaching request context to the logger to include a request UUID, method, and route in all log messages.
  • Process X-Forwarded-* headers to determine the source IP and related information of the request.
  • Gather and structure standard metadata about your application.
  • Operate a distributed Redis job queue with arq using convenient clients, testing mocks, and a FastAPI dependency.

Developing Safir

See https://safir.lsst.io/dev/development.html.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

safir-6.5.1.tar.gz (169.0 kB view details)

Uploaded Source

Built Distribution

safir-6.5.1-py3-none-any.whl (141.7 kB view details)

Uploaded Python 3

File details

Details for the file safir-6.5.1.tar.gz.

File metadata

  • Download URL: safir-6.5.1.tar.gz
  • Upload date:
  • Size: 169.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for safir-6.5.1.tar.gz
Algorithm Hash digest
SHA256 8c4b85f07e2343848f598bbcba832fec6725219c4234e2a05e97e5623347d6bf
MD5 4a3e094327fb729a7432f779d8269b2e
BLAKE2b-256 1e586848bbdef69ffa60072455389ae156def8210d62abb03c7561cb617fc3fc

See more details on using hashes here.

File details

Details for the file safir-6.5.1-py3-none-any.whl.

File metadata

  • Download URL: safir-6.5.1-py3-none-any.whl
  • Upload date:
  • Size: 141.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for safir-6.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e00167de168115477309436f136bd3c01623dfc362b9d32bc6c87ea65857f993
MD5 e112390d19e85fba5337030ce27a4ba0
BLAKE2b-256 7f97a581169e2c567f1da9324a46baa704d737fa092ef4c91971fb81751afe2e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page