Steadwing Python SDK

Error monitoring with AI-powered Root Cause Analysis for Python applications.

PyPI | Docs | Discord

Overview

The Steadwing Python SDK auto-instruments your application to capture exceptions, error logs, and HTTP breadcrumbs then sends them to Steadwing for automated Root Cause Analysis.

Key features:

  • Automatic exception capture (including threads and async)
  • logging.error() / logging.critical() forwarding
  • HTTP request breadcrumbs for debugging context
  • Built-in data scrubbing for sensitive fields
  • Framework integrations for FastAPI, Django, Flask, and more

Installation

pip install steadwing

Requires Python 3.10+

Quick Start

import steadwing

steadwing.init(api_key="st_your_api_key")

That's it. Steadwing is now capturing errors in your application.

Configuration

steadwing.init(
    api_key="st_...",           # Required: your API key
    service="my-service",       # Service name for grouping (default: "default")
    env="PROD",                 # Deployment environment (default: "PROD")
    enabled=True,               # Set False to disable
)
Option Type Default Description
api_key str - Your Steadwing API key (required)
service str "default" Service name for grouping errors
env str "PROD" Deployment environment ("PROD", "DEV", etc.)
enabled bool True Toggle SDK on/off

Note: Only events sent with env="PROD" are considered for auto-monitoring. Events from other environments are received but will not trigger automated RCA.

Usage

Automatic Capture

Once initialized, Steadwing automatically captures:

  • Unhandled exceptions: including in threads and async tasks
  • Error logs: logging.error() and logging.critical() calls
  • Breadcrumbs: outgoing HTTP requests, log messages (rolling buffer of last 100)

Manual Capture

import steadwing

# Capture a specific exception
try:
    risky_operation()
except Exception as e:
    steadwing.capture_exception(e)

# Capture the current exception (in an except block)
try:
    risky_operation()
except Exception:
    steadwing.capture_exception()

# Capture a message
steadwing.capture_message("Deployment completed", level="info")

Integrations

Steadwing provides first-class support for popular Python frameworks:

Framework Auto-instrumentation
FastAPI Route errors with request context
Django Middleware-based exception capture
Flask Error handler integration
SQLAlchemy Database query breadcrumbs
asyncio Async task exception capture

Integrations are automatically activated when the corresponding library is detected.

Data Scrubbing

Sensitive data is automatically scrubbed from captured events. Keys matching the following patterns (case-insensitive) have their values replaced with [REDACTED]:

password · passwd · secret · api_key · apikey · token · auth · authorization · cookie · csrf · session · credit_card · ssn

Contributing

We welcome contributions! Here's how to get started:

# Clone the repository
git clone https://github.com/steadwing/steadwing-python.git
cd steadwing-python

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

Community

  • Discord - Ask questions, share feedback, and connect with the team
  • GitHub Issues - Report bugs or request features

License

This project is licensed under the Apache License 2.0.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.1.4)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for dev-khant from gravatar.com dev-khant

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.10

Report project as malware

Download files

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

Source Distribution

steadwing-0.1.3.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

steadwing-0.1.3-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

Details for the file steadwing-0.1.3.tar.gz.

File metadata

  • Download URL: steadwing-0.1.3.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for steadwing-0.1.3.tar.gz
Algorithm Hash digest
SHA256 27c6a4e689ccc763cef0f0f24c6d990683dc109786b7a9755f4367faa6e95341
MD5 d4d9f48cd59bd1da9b3f284a2827a579
BLAKE2b-256 514779117493291c652ad8a05832c6b7cf0a98249320e87dd62a57b06cb4c786

See more details on using hashes here.

Provenance

The following attestation bundles were made for steadwing-0.1.3.tar.gz:

Publisher: publish.yml on steadwing/steadwing-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file steadwing-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: steadwing-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 26.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for steadwing-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 74a650e1d600d50646a081a11c0e413e0fe303bd1bfce4b8956cdfc78d0d4d45
MD5 d1db595ba513f83262c3cc3ce1fdcde3
BLAKE2b-256 5fec9c389b0d674fafa804cee0b2e083e29acfa2acdbabc1ad4c8ba1ee3d394b

See more details on using hashes here.

Provenance

The following attestation bundles were made for steadwing-0.1.3-py3-none-any.whl:

Publisher: publish.yml on steadwing/steadwing-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.4

2 files

This release

0.1.3 This release

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page