Skip to main content

Reusable, extensible Django notification framework with Email, SMS and Firebase Push support

Project description

Django Notification Kit Django Notification Kit, Django projeleri için tasarlanmış; çok kanallı (Email / SMS / Push) bildirim gönderimini yöneten, modüler ve genişletilebilir bir altyapıdır. Sistemin temel amacı; bildirim gönderim süreçlerini API – Service – Backend – Task katmanlarına ayırarak yüksek test edilebilirlik ve sürdürülebilirlik sağlamaktır.

Kapsam (v1.0.0 – MVP) Bu versiyon, profesyonel bir bildirim sistemi için gerekli olan şu temel bileşenleri sunar:

Abstract Model Yapısı: Genişletilmeye hazır taban modeller.

Concrete Modeller: Notification, Template, Preference ve Log yapıları.

SMTP Email Backend: Standart e-posta gönderim desteği.

Base Notification Service: İş mantığını yöneten merkezi servis.

Celery Task Factory: Ölçeklenebilir, asenkron gönderim desteği.

DRF API: Standartlara uygun API uçları ve Serializer'lar.

Merkezi Ayar Yönetimi: NOTIFICATION_KIT üzerinden tam kontrol.

Full Testing: Unit, API ve Performans testleri.

Mimari Genel Bakış Sistem, sorumlulukların net ayrıştırıldığı Layered Architecture (Katmanlı Mimari) prensibiyle tasarlanmıştır.Katmanların SorumluluklarıKatmanSorumluluk AlanıAPIRequest validation, permission kontrolü, throttling.Serviceİş kuralları, kanal seçimi, retry logic yönetimi.BackendKanal spesifik (Email, SMS vb.) düşük seviyeli implementasyon.TaskAsenkron (Async) ve toplu (Batch) işlem yönetimi (Celery).ModelsVeri şeması; Notification, Template ve Kullanıcı tercihleri.SettingsMerkezi ve projeye özel override edilebilir konfigürasyon.

Ayar Yönetimi Paket içi ayarlar notification_kit/settings.py dosyasında tanımlıdır. Proje bazlı özelleştirmeler için ana settings.py dosyanızda NOTIFICATION_KIT sözlüğünü kullanabilirsiniz.

Python

project/settings.py

NOTIFICATION_KIT = { "ASYNC": True, "MAX_RETRIES": 5, "EMAIL": { "FROM_EMAIL": "noreply@example.com", "RATE_LIMIT": 200, }, } Not: Hassas veriler (API Key, Şifre vb.) her zaman çevre değişkenleri (environment variables) üzerinden yönetilmelidir.

Teknik Implementasyon

  1. Backend Yapısı Her kanal (SMS, Email, Push) için bir backend sınıfı bulunur. Yeni bir sağlayıcı eklemek oldukça basittir:

Python class BaseBackend: def send(self, notification): raise NotImplementedError("Bu metod implemente edilmelidir.") 2. Service Katmanı İş mantığının kalbidir. API'den gelen isteği alır, hangi kanalın kullanılacağına karar verir ve gerekirse işi Celery'ye devreder.

Kanal Seçimi: Template üzerinden dinamik kanal yönetimi.

Soyutlama: Backend implementasyonundan bağımsız çalışma.

  1. API Katmanı Yalnızca bildirim oluşturma ve tetikleme sorumluluğunu taşır.

Validation: Serializer'lar ile veri doğruluğu garanti edilir.

Security: Permission sınıfları ile yetkisiz erişim engellenir.

Güvenlik Yaklaşımı Veri Gizliliği: Kişisel veriler (PII) kesinlikle loglanmaz.

Hız Sınırı: API düzeyinde Throttling ile brute-force ve aşırı yüklenme engellenir.

Denetim: Tüm gönderim denemeleri ve sonuçları NotificationLog üzerinden izlenebilir.

Test Stratejisi Sistem, Pytest altyapısı kullanılarak aşağıdaki seviyelerde test edilmektedir:

Model: Veri bütünlüğü ve ilişki testleri.

Service: İş mantığı ve kanal yönlendirme testleri.

Backend: Provider entegrasyon (mock) testleri.

API: Endpoint erişim ve veri formatı testleri.

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

notification_kit-1.1.0.tar.gz (20.1 kB view details)

Uploaded Source

Built Distribution

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

notification_kit-1.1.0-py3-none-any.whl (29.7 kB view details)

Uploaded Python 3

File details

Details for the file notification_kit-1.1.0.tar.gz.

File metadata

  • Download URL: notification_kit-1.1.0.tar.gz
  • Upload date:
  • Size: 20.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for notification_kit-1.1.0.tar.gz
Algorithm Hash digest
SHA256 0e0b9c5d4e010b16e8454589c4a25dff4b29bcfff4f66d0b8166da85d0dbcb5a
MD5 83ffda05c74aae36816d8e088f8cd979
BLAKE2b-256 9b92fac5d9d2c6f0a605ea728a0ae1363884f417702867a53bb6759fb74fd4b7

See more details on using hashes here.

File details

Details for the file notification_kit-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for notification_kit-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 926d3ab8a7abafbc405caee0e6068d0b63b107e82509bdf3b3941b84087fdeef
MD5 002ffc922b30ceb23b7757a48700531c
BLAKE2b-256 1e10f918c6b56c269bdc2f7aeeebce1665cc81acbf59d3a41feb633f0a1a398e

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