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]"

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.2.tar.gz (12.8 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.2-py2.py3-none-any.whl (9.6 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for sift_dev_logger-1.0.2.tar.gz
Algorithm Hash digest
SHA256 1b51ed9bcbe7ce6ef282d695bb631dcf4ea2bd92fd3bdc5ba65fe3cfa86eb1f2
MD5 61e7aabbd44eab292ba7314aff3481ad
BLAKE2b-256 5d1d638b47c5dcce92f699b978cbee99724f7f002847d1d2c8d4eb36aba381ad

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sift_dev_logger-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 28275ccbeacc6ac099b29458806c8e73ccd9bfa9bba3050f2969447e8d88fea2
MD5 684f9097144140084c42756ae8d7d4af
BLAKE2b-256 1b0d5ef1a2ab90dfdf53ba603bbe5a2d9f64cfdb4451b7db38cb226682de20c9

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