oxutils 0.1.3__tar.gz → 0.1.4__tar.gz

{oxutils-0.1.3 → oxutils-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oxutils
-Version: 0.1.3
+Version: 0.1.4
 Summary: Production-ready utilities for Django applications in the Oxiliere ecosystem
 Keywords: django,utilities,jwt,s3,audit,logging,celery,structlog
 Author: Edimedia Mutoke
@@ -13,16 +13,15 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Dist: bcc-rates>=1.1.0
 Requires-Dist: boto3>=1.41.5
 Requires-Dist: celery>=5.5.3
 Requires-Dist: cryptography>=46.0.3
 Requires-Dist: django-auditlog>=3.3.0
 Requires-Dist: django-celery-results>=2.6.0
-Requires-Dist: django-cid>=3.0
 Requires-Dist: django-extensions>=4.1
 Requires-Dist: django-ninja>=1.5.0
 Requires-Dist: django-ninja-extra>=0.30.6
@@ -32,7 +31,7 @@ Requires-Dist: jwcrypto>=1.5.6
 Requires-Dist: pydantic-settings>=2.12.0
 Requires-Dist: pyjwt>=2.10.1
 Requires-Dist: requests>=2.32.5
-Requires-Python: >=3.11
+Requires-Python: >=3.12
 Project-URL: Changelog, https://github.com/oxiliere/oxutils/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://github.com/oxiliere/oxutils/tree/main/docs
 Project-URL: Homepage, https://github.com/oxiliere/oxutils
@@ -45,7 +44,7 @@ Description-Content-Type: text/markdown
 **Production-ready utilities for Django applications in the Oxiliere ecosystem.**
 
 [![PyPI version](https://img.shields.io/pypi/v/oxutils.svg)](https://pypi.org/project/oxutils/)
-[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/)
 [![Django 5.0+](https://img.shields.io/badge/django-5.0+-green.svg)](https://www.djangoproject.com/)
 [![Tests](https://img.shields.io/badge/tests-145%20passed-success.svg)](tests/)
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
@@ -55,7 +54,7 @@ Description-Content-Type: text/markdown
 
 - 🔐 **JWT Authentication** - RS256 with JWKS caching
 - 📦 **S3 Storage** - Static, media, private, and log backends
-- 📝 **Structured Logging** - JSON logs with correlation IDs
+- 📝 **Structured Logging** - JSON logs with automatic request tracking
 - 🔍 **Audit System** - Change tracking with S3 export
 - ⚙️ **Celery Integration** - Pre-configured task processing
 - 🛠️ **Django Mixins** - UUID, timestamps, user tracking
@@ -83,12 +82,12 @@ uv add oxutils
 from oxutils.conf import UTILS_APPS, AUDIT_MIDDLEWARE
 
 INSTALLED_APPS = [
-    *UTILS_APPS,  # structlog, auditlog, cid, celery_results
+    *UTILS_APPS,  # structlog, auditlog, celery_results
     # your apps...
 ]
 
 MIDDLEWARE = [
-    *AUDIT_MIDDLEWARE,  # CID, Auditlog, RequestMiddleware
+    *AUDIT_MIDDLEWARE,  # RequestMiddleware, Auditlog
     # your middleware...
 ]
 ```
@@ -152,7 +151,7 @@ TEMPLATES = [{
 
 ## Requirements
 
-- Python 3.11+
+- Python 3.12+
 - Django 5.0+
 - PostgreSQL (recommended)
 

{oxutils-0.1.3 → oxutils-0.1.4}/README.md

@@ -3,7 +3,7 @@
 **Production-ready utilities for Django applications in the Oxiliere ecosystem.**
 
 [![PyPI version](https://img.shields.io/pypi/v/oxutils.svg)](https://pypi.org/project/oxutils/)
-[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/)
 [![Django 5.0+](https://img.shields.io/badge/django-5.0+-green.svg)](https://www.djangoproject.com/)
 [![Tests](https://img.shields.io/badge/tests-145%20passed-success.svg)](tests/)
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
@@ -13,7 +13,7 @@
 
 - 🔐 **JWT Authentication** - RS256 with JWKS caching
 - 📦 **S3 Storage** - Static, media, private, and log backends
-- 📝 **Structured Logging** - JSON logs with correlation IDs
+- 📝 **Structured Logging** - JSON logs with automatic request tracking
 - 🔍 **Audit System** - Change tracking with S3 export
 - ⚙️ **Celery Integration** - Pre-configured task processing
 - 🛠️ **Django Mixins** - UUID, timestamps, user tracking
@@ -41,12 +41,12 @@ uv add oxutils
 from oxutils.conf import UTILS_APPS, AUDIT_MIDDLEWARE
 
 INSTALLED_APPS = [
-    *UTILS_APPS,  # structlog, auditlog, cid, celery_results
+    *UTILS_APPS,  # structlog, auditlog, celery_results
     # your apps...
 ]
 
 MIDDLEWARE = [
-    *AUDIT_MIDDLEWARE,  # CID, Auditlog, RequestMiddleware
+    *AUDIT_MIDDLEWARE,  # RequestMiddleware, Auditlog
     # your middleware...
 ]
 ```
@@ -110,7 +110,7 @@ TEMPLATES = [{
 
 ## Requirements
 
-- Python 3.11+
+- Python 3.12+
 - Django 5.0+
 - PostgreSQL (recommended)
 

{oxutils-0.1.3 → oxutils-0.1.4}/pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "oxutils"
-version = "0.1.3"
+version = "0.1.4"
 description = "Production-ready utilities for Django applications in the Oxiliere ecosystem"
 readme = "README.md"
 license = "Apache-2.0"
 authors = [
     { name = "Edimedia Mutoke", email = "eddycondor07@gmail.com" }
 ]
-requires-python = ">=3.11"
+requires-python = ">=3.12"
 keywords = ["django", "utilities", "jwt", "s3", "audit", "logging", "celery", "structlog"]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -17,18 +17,17 @@ classifiers = [
     "License :: OSI Approved :: Apache Software License",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Internet :: WWW/HTTP",
 ]
 dependencies = [
+    "bcc-rates>=1.1.0",
     "boto3>=1.41.5",
     "celery>=5.5.3",
     "cryptography>=46.0.3",
     "django-auditlog>=3.3.0",
     "django-celery-results>=2.6.0",
-    "django-cid>=3.0",
     "django-extensions>=4.1",
     "django-ninja>=1.5.0",
     "django-ninja-extra>=0.30.6",
@@ -69,7 +68,7 @@ dev = [
 
 [tool.ruff]
 line-length = 100
-target-version = "py311"
+target-version = "py312"
 exclude = [
     ".git",
     ".venv",

{oxutils-0.1.3 → oxutils-0.1.4}/src/oxutils/__init__.py

@@ -10,7 +10,7 @@ This package provides:
 - Custom exceptions
 """
 
-__version__ = "0.1.3"
+__version__ = "0.1.4"
 
 from oxutils.settings import oxi_settings
 from oxutils.conf import UTILS_APPS, AUDIT_MIDDLEWARE

oxutils-0.1.4/src/oxutils/audit/settings.py

@@ -0,0 +1,4 @@
+# Oxiliere Audit settings
+
+AUDITLOG_CID_GETTER = "oxutils.audit.utils.get_request_id"
+AUDITLOG_LOGENTRY_MODEL =  "auditlog.LogEntry"

oxutils-0.1.4/src/oxutils/audit/utils.py

@@ -0,0 +1,22 @@
+"""
+Utility functions for audit logging.
+"""
+import structlog
+
+
+def get_request_id():
+    """
+    Get the request_id from django-structlog context.
+    
+    This function retrieves the request_id that was set by 
+    django-structlog's RequestMiddleware and returns it for use
+    in auditlog's correlation ID field.
+    
+    Returns:
+        str: The request_id from the current request context, or None if not available.
+    """
+    try:
+        context = structlog.contextvars.get_contextvars()
+        return context.get('request_id')
+    except Exception:
+        return None

{oxutils-0.1.3 → oxutils-0.1.4}/src/oxutils/conf.py

@@ -1,13 +1,11 @@
 UTILS_APPS = (
     'django_structlog',
     'auditlog',
-    'cid.apps.CidAppConfig',
     'django_celery_results',
     'oxutils.audit',
 )
 
 AUDIT_MIDDLEWARE = (
-    'cid.middleware.CidMiddleware',
-    'auditlog.middleware.AuditlogMiddleware',
     'django_structlog.middlewares.RequestMiddleware',
+    'auditlog.middleware.AuditlogMiddleware',
 )

oxutils-0.1.4/src/oxutils/currency/admin.py

@@ -0,0 +1,57 @@
+from django.contrib import admin
+from .models import CurrencyState, Currency
+
+
+class CurrencyInline(admin.TabularInline):
+    model = Currency
+    extra = 0
+    readonly_fields = ('id', 'code', 'rate')
+    can_delete = False
+    
+    def has_add_permission(self, request, obj=None):
+        return False
+
+
+@admin.register(CurrencyState)
+class CurrencyStateAdmin(admin.ModelAdmin):
+    list_display = ('id', 'source', 'currency_count', 'created_at', 'updated_at')
+    list_filter = ('source', 'created_at')
+    readonly_fields = ('id', 'created_at', 'updated_at')
+    search_fields = ('id', 'source')
+    ordering = ('-created_at',)
+    inlines = [CurrencyInline]
+    
+    def currency_count(self, obj):
+        return obj.currencies.count()
+    currency_count.short_description = 'Currencies'
+    
+    def has_add_permission(self, request):
+        return False
+    
+    def has_delete_permission(self, request, obj=None):
+        return request.user.is_superuser
+
+
+@admin.register(Currency)
+class CurrencyAdmin(admin.ModelAdmin):
+    list_display = ('id', 'code', 'rate', 'state_source', 'state_created_at')
+    list_filter = ('code', 'state__source', 'state__created_at')
+    readonly_fields = ('id', 'code', 'rate', 'state')
+    search_fields = ('code', 'state__id')
+    ordering = ('code',)
+    
+    def state_source(self, obj):
+        return obj.state.source
+    state_source.short_description = 'Source'
+    state_source.admin_order_field = 'state__source'
+    
+    def state_created_at(self, obj):
+        return obj.state.created_at
+    state_created_at.short_description = 'State Created'
+    state_created_at.admin_order_field = 'state__created_at'
+    
+    def has_add_permission(self, request):
+        return False
+    
+    def has_delete_permission(self, request, obj=None):
+        return request.user.is_superuser

oxutils-0.1.4/src/oxutils/currency/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class CurrencyConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'oxutils.currency'
+    verbose_name = "Oxutils Currency"

oxutils-0.1.4/src/oxutils/currency/controllers.py

@@ -0,0 +1,78 @@
+from django.http import HttpRequest
+from django.core.exceptions import ObjectDoesNotExist
+from ninja_extra import (
+    ControllerBase,
+    api_controller,
+    http_get,
+)
+from ninja_extra.pagination import (
+    paginate, PageNumberPaginationExtra, PaginatedResponseSchema
+)
+from ninja.errors import HttpError
+from uuid import UUID
+import structlog
+from currency.models import CurrencyState
+from currency.schemas import (
+    CurrencyStateSchema,
+    CurrencyStateDetailSchema,
+)
+
+logger = structlog.get_logger(__name__)
+
+
+@api_controller('/currency', tags=['Currency'], auth=None)
+class CurrencyController(ControllerBase):
+    
+    @http_get('/states', response=PaginatedResponseSchema[CurrencyStateSchema])
+    @paginate(PageNumberPaginationExtra, page_size=20)
+    def list_states(self, request: HttpRequest):
+        return CurrencyState.objects.all().order_by('-created_at')
+    
+    @http_get('/states/latest', response=CurrencyStateDetailSchema)
+    def get_latest_state(self, request: HttpRequest):
+        try:
+            state = CurrencyState.objects.latest()
+        except ObjectDoesNotExist:
+            logger.error("currency_state_not_found", message="No currency state found in database")
+            raise HttpError(404, "No currency state found in database")
+        
+        return {
+            'id': state.id,
+            'source': state.source,
+            'created_at': state.created_at,
+            'updated_at': state.updated_at,
+            'currencies': {c.code: float(c.rate) for c in state.currencies.all()}
+        }
+    
+    @http_get('/states/{state_id}', response=CurrencyStateDetailSchema)
+    def get_state(self, request: HttpRequest, state_id: UUID):
+        state = CurrencyState.objects.prefetch_related('currencies').get(id=state_id)
+        return {
+            'id': state.id,
+            'source': state.source,
+            'created_at': state.created_at,
+            'updated_at': state.updated_at,
+            'currencies': {c.code: float(c.rate) for c in state.currencies.all()}
+        }
+    
+    @http_get('/rates', response=dict[str, float])
+    def get_current_rates(self, request: HttpRequest):
+        try:
+            state = CurrencyState.objects.latest()
+        except ObjectDoesNotExist:
+            logger.error("currency_state_not_found", message="No currency state found in database")
+            raise HttpError(404, "No currency rates available")
+        
+        currencies = state.currencies.all()
+        return {c.code: float(c.rate) for c in currencies}
+    
+    @http_get('/rates/{code}', response=dict[str, float])
+    def get_rate_by_code(self, request: HttpRequest, code: str):
+        try:
+            state = CurrencyState.objects.latest()
+            currency = state.currencies.get(code=code.upper())
+        except ObjectDoesNotExist:
+            logger.error("currency_rate_not_found", code=code.upper())
+            raise HttpError(404, f"Currency rate for {code.upper()} not found")
+        
+        return {currency.code: float(currency.rate)}

oxutils-0.1.4/src/oxutils/currency/enums.py

@@ -0,0 +1,7 @@
+from django.db.models import TextChoices
+
+
+class CurrencySource(TextChoices):
+    BCC = "bcc", "BCC"
+    OXR = "oxr", "Open Exchange Rates"
+

oxutils-0.1.4/src/oxutils/currency/migrations/0001_initial.py

@@ -0,0 +1,41 @@
+# Generated by Django 5.2.9 on 2025-12-19 14:34
+
+import django.db.models.deletion
+import uuid
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='CurrencyState',
+            fields=[
+                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='Unique identifier for this record', primary_key=True, serialize=False)),
+                ('created_at', models.DateTimeField(auto_now_add=True, help_text='Date and time when this record was created')),
+                ('updated_at', models.DateTimeField(auto_now=True, help_text='Date and time when this record was last updated')),
+                ('source', models.CharField(choices=[('bcc', 'BCC'), ('oxr', 'Open Exchange Rates')], max_length=10)),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+        migrations.CreateModel(
+            name='Currency',
+            fields=[
+                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='Unique identifier for this record', primary_key=True, serialize=False)),
+                ('code', models.CharField(max_length=10)),
+                ('rate', models.DecimalField(decimal_places=4, max_digits=10)),
+                ('state', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='currencies', to='currency.currencystate')),
+            ],
+            options={
+                'ordering': ['code'],
+                'indexes': [models.Index(fields=['code', 'state'], name='currency_cu_code_c68344_idx')],
+            },
+        ),
+    ]

oxutils-0.1.4/src/oxutils/currency/models.py

@@ -0,0 +1,100 @@
+from typing import Optional
+from django.db import models
+from django.db import transaction
+import structlog
+from oxutils.models import (
+    UUIDPrimaryKeyMixin,
+    TimestampMixin,
+)
+from .enums import CurrencySource
+from .utils import load_rates
+
+
+
+logger = structlog.get_logger(__name__)
+
+
+AVAILABLES_CURRENCIES = [
+    "AOA",   
+    "AUD",   
+    "BIF",   
+    "CAD",   
+    "CHF",   
+    "CNY",   
+    "EUR",
+    "GBP",
+    "JPY",    
+    "RWF",    
+    "TZS",    
+    "UGX",    
+    "USD",    
+    "XAF",    
+    "XDR",    
+    "ZAR",
+    "ZMW"
+]
+
+
+class CurrencyStateManager(models.Manager):
+    def latest(self):
+        return self.get_queryset().prefetch_related("currencies").latest("created_at")
+
+class CurrencyState(UUIDPrimaryKeyMixin, TimestampMixin):
+    source = models.CharField(max_length=10, choices=CurrencySource.choices)
+    objects = CurrencyStateManager()
+    
+    @classmethod
+    def sync(cls) -> Optional['CurrencyState']:
+        rates, source = load_rates()
+        currencies = []
+
+        if not rates:
+            logger.error("currency_state_sync_failed", source=source)
+            raise ValueError("No rates found")
+
+        with transaction.atomic():
+            state = cls.objects.create(source=source)
+
+            for rate in rates:
+                currency = Currency(
+                    code=rate.currency,
+                    rate=rate.amount,
+                    state=state
+                )
+                currencies.append(currency)
+
+            Currency.objects.bulk_create(currencies)
+
+            logger.info("currency_state_synced", state=state.id, source=source)
+
+            return state
+
+
+class Currency(UUIDPrimaryKeyMixin):
+    code = models.CharField(max_length=10)
+    rate = models.DecimalField(max_digits=10, decimal_places=4)
+    state = models.ForeignKey(
+        CurrencyState, 
+        on_delete=models.CASCADE,
+        related_name="currencies"
+    )
+
+    class Meta:
+        ordering = ['code']
+        indexes = [
+            models.Index(fields=['code', 'state']),
+        ]
+
+    def __str__(self):
+        return f"{self.code} - {self.rate}"
+
+    def clean(self):
+        if self.code not in AVAILABLES_CURRENCIES:
+            raise ValueError(f"Invalid currency code: {self.code}")
+
+        if self.rate <= 0:
+            raise ValueError(f"Invalid currency rate: {self.rate}")
+
+    def save(self, *args, **kwargs):
+        self.clean()
+        super().save(*args, **kwargs)

oxutils-0.1.4/src/oxutils/currency/schemas.py

@@ -0,0 +1,38 @@
+from ninja import Schema
+from datetime import datetime
+from uuid import UUID
+from decimal import Decimal
+
+
+class CurrencySchema(Schema):
+    code: str
+    rate: Decimal
+
+    class Config:
+        from_attributes = True
+
+
+class CurrencyStateSchema(Schema):
+    id: UUID
+    source: str
+    created_at: datetime
+    updated_at: datetime
+
+    class Config:
+        from_attributes = True
+
+
+class CurrencyStateDetailSchema(Schema):
+    id: UUID
+    source: str
+    created_at: datetime
+    updated_at: datetime
+    currencies: dict[str, float]
+
+    class Config:
+        from_attributes = True
+
+
+class CurrencyRateSchema(Schema):
+    code: str
+    rate: Decimal

oxutils-0.1.4/src/oxutils/currency/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

oxutils-0.1.4/src/oxutils/currency/utils.py

@@ -0,0 +1,31 @@
+import time
+from django.conf import settings
+from bcc_rates import BCCBankSource, OXRBankSource, SourceValue
+from oxutils.currency.enums import CurrencySource
+
+
+
+def load_rates() -> tuple[list[SourceValue], CurrencySource]:
+    max_retries = 3
+    retry_count = 0
+    
+    while retry_count < max_retries:
+        try:
+            bcc_source = BCCBankSource()
+            rates = bcc_source.sync(cache=True)
+            return rates, CurrencySource.BCC
+        except Exception as e:
+            retry_count += 1
+            if retry_count < max_retries:
+                time.sleep(1)
+            else:
+                if not getattr(settings, 'OXI_BCC_FALLBACK_ON_OXR', False):
+                    raise Exception(f"Failed to load rates from BCC: {str(e)}")
+                break
+    
+    try:
+        oxr_source = OXRBankSource()
+        rates = oxr_source.sync(cache=True)
+        return rates, CurrencySource.OXR
+    except Exception as e:
+        raise Exception(f"Failed to load rates from both BCC and OXR: {str(e)}")

{oxutils-0.1.3 → oxutils-0.1.4}/src/oxutils/logger/receivers.py

@@ -2,7 +2,6 @@ from django.contrib.sites.shortcuts import RequestSite
 from django.dispatch import receiver
 import structlog
 from django_structlog import signals
-from cid.locals import get_cid
 from oxutils.settings import oxi_settings
 
 
@@ -12,7 +11,6 @@ def bind_domain(request, logger, **kwargs):
     current_site = RequestSite(request)
     structlog.contextvars.bind_contextvars(
         domain=current_site.domain,
-        cid=get_cid(),
         user_id=str(request.user.pk),
         service=oxi_settings.service_name
     )

oxutils-0.1.3/src/oxutils/audit/settings.py

@@ -1,19 +0,0 @@
-# Oxiliere Audit settings
-
-AUDITLOG_DISABLE_REMOTE_ADDR = False
-AUDITLOG_MASK_TRACKING_FIELDS = (
-    "password",
-    "api_key",
-    "secret_token",
-    "token",
-)
-
-AUDITLOG_EXCLUDE_TRACKING_FIELDS = (
-    "created_at",
-    "updated_at",
-)
-
-CID_GENERATE = False
-
-AUDITLOG_CID_GETTER = "cid.locals.get_cid"
-AUDITLOG_LOGENTRY_MODEL =  "auditlog.LogEntry"