Skip to main content

A logging SDK for Sift Dev that supports Flask and FastAPI

Project description

SIFT dev-logger

A Python logging SDK that provides structured logging for Flask and FastAPI applications.


Installation

Using pip

pip install sift-dev-logger

With optional Flask support:

pip install "sift-dev-logger[flask]"

With optional FastAPI support:

pip install "sift-dev-logger[fastapi]"

With all library support:

pip install "sift-dev-logger[all]"

Usage

Flask Application

from flask import Flask
from sift_dev_logger.config import SiftDevConfig, configure
from sift_dev_logger.flask import instrument_logging_middleware

app = Flask(__name__)

# Configure the SDK
config = SiftDevConfig(
   service_name="my-flask-app",
   service_instance="my-instance",
   sift_dev_logging_project_key="my-project-key"
)
configure(config)

# Add logging middleware
instrument_logging_middleware(app)

FastAPI Application

from fastapi import FastAPI
from sift_dev_logger.config import SiftDevConfig, configure
from sift_dev_logger.fastapi import instrument_logging_middleware

app = FastAPI()

# Configure the SDK
config = SiftDevConfig(
   service_name="my-fastapi-app",
   service_instance="my-instance",
   sift_dev_logging_project_key="my-project-key"
)
configure(config)

# Add logging middleware
instrument_logging_middleware(app)

How to build and publish

  1. Install build tools:

    pip install build
    
  2. Build the package:

    python -m build
    
  3. Test the package locally:

    pip install sift_dev_logger-0.1.0.tar.gz
    
  4. Upload to PyPI (you’ll need to create an account first):

    python -m twine upload dist/*
    

Key Features

  1. Optional Dependencies: Users can install just what they need (core, Flask, or FastAPI support).
  2. Modern Build System: Uses hatchling for a clean, modern build.
  3. Clear Documentation: README shows installation and basic usage.
  4. Version Management: Easy to update version in one place.
  5. Development Tooling: Development dependencies separated from runtime requirements.

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

sift_dev_logger-1.0.9.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

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

sift_dev_logger-1.0.9-py2.py3-none-any.whl (11.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file sift_dev_logger-1.0.9.tar.gz.

File metadata

  • Download URL: sift_dev_logger-1.0.9.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for sift_dev_logger-1.0.9.tar.gz
Algorithm Hash digest
SHA256 c294614b9e8438f45499d8540283a8e4ff6482af03ddc26e9b6d02055ca0ee79
MD5 0aab82847dd77f67cbad26517ba9272c
BLAKE2b-256 47fedba93be922c05a630521fdb528a5c92182b3ee71e6adfaef7fe176585c3f

See more details on using hashes here.

File details

Details for the file sift_dev_logger-1.0.9-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sift_dev_logger-1.0.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4f327668b04877e01e66d0c15b50d607d595da89ae0b6cad9c313933e6d261c6
MD5 32fc16cbaeda64f303ef19ab615dadba
BLAKE2b-256 f597e1be4f35556eb87d69d1c2d09dd190cf63b009af51f2588fabffc68e3180

See more details on using hashes here.

Supported by

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