sift-dev-logger 1.0.0

A logging SDK for Sift Dev that supports Flask and FastAPI

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_integration 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_integration 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.

---