django-nepkit 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

example/demo/serializers.py

@@ -0,0 +1,39 @@
+from rest_framework import serializers
+from django_nepkit.serializers import (
+    NepaliDateSerializerField,
+    NepaliCurrencySerializerField,
+    NepaliLocalizedSerializerMixin,
+)
+from .models import Person, Citizen, AuditedPerson, Transaction
+
+
+class PersonSerializer(NepaliLocalizedSerializerMixin, serializers.ModelSerializer):
+    birth_date = NepaliDateSerializerField()
+
+    class Meta:
+        model = Person
+        fields = "__all__"
+
+
+class TransactionSerializer(
+    NepaliLocalizedSerializerMixin, serializers.ModelSerializer
+):
+    amount_formatted = NepaliCurrencySerializerField(source="amount")
+
+    class Meta:
+        model = Transaction
+        fields = ["id", "title", "amount", "amount_formatted", "date"]
+
+
+class CitizenSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Citizen
+        fields = "__all__"
+
+
+class AuditedPersonSerializer(serializers.ModelSerializer):
+    birth_date = NepaliDateSerializerField()
+
+    class Meta:
+        model = AuditedPerson
+        fields = "__all__"

example/demo/urls.py

@@ -1,9 +1,20 @@
-from django.urls import path
 from . import views
+from rest_framework.routers import DefaultRouter
+from django.urls import path
 
 app_name = "demo"
 
+router = DefaultRouter()
+router.register("api/persons", views.PersonViewSet, basename="person-api")
+router.register("api/citizens", views.CitizenViewSet, basename="citizen-api")
+router.register("api/audited", views.AuditedPersonViewSet, basename="audited-api")
+router.register(
+    "api/transactions", views.TransactionViewSet, basename="transaction-api"
+)
+
 urlpatterns = [
     path("", views.person_list, name="person-list"),
     path("add/", views.person_create, name="person-create"),
-]
+    path("transactions/add/", views.transaction_create, name="transaction-create"),
+    path("normalize/", views.address_normalize_demo, name="address-normalize"),
+] + router.urls

example/demo/views.py

@@ -1,6 +1,20 @@
-from django.shortcuts import render, redirect
-from .models import Person
 from django import forms
+from django.shortcuts import render, redirect
+from rest_framework import viewsets, filters as drf_filters
+from django_filters import rest_framework as django_filters
+from django_nepkit.filters import NepaliDateYearFilter, NepaliDateMonthFilter
+from .models import Person, Citizen, AuditedPerson, Transaction
+from .serializers import (
+    PersonSerializer,
+    CitizenSerializer,
+    AuditedPersonSerializer,
+    TransactionSerializer,
+)
+from django_nepkit.filters import (
+    NepaliCurrencyRangeFilter,
+    NepaliDateRangeFilter,
+)
+from django_nepkit.utils import normalize_address
 
 
 class PersonForm(forms.ModelForm):
@@ -9,16 +23,25 @@ class PersonForm(forms.ModelForm):
         fields = [
             "name",
             "birth_date",
+            "birth_date_ne",
             "phone_number",
             "province",
+            "province_ne",
             "district",
+            "district_ne",
             "municipality",
+            "municipality_ne",
         ]
 
 
 def person_list(request):
     persons = Person.objects.all()
-    return render(request, "demo/person_list.html", {"persons": persons})
+    transactions = Transaction.objects.all()
+    return render(
+        request,
+        "demo/person_list.html",
+        {"persons": persons, "transactions": transactions},
+    )
 
 
 def person_create(request):
@@ -30,3 +53,102 @@ def person_create(request):
     else:
         form = PersonForm()
     return render(request, "demo/person_form.html", {"form": form})
+
+
+class TransactionForm(forms.ModelForm):
+    class Meta:
+        model = Transaction
+        fields = ["title", "amount"]
+
+
+def transaction_create(request):
+    if request.method == "POST":
+        form = TransactionForm(request.POST)
+        if form.is_valid():
+            form.save()
+            return redirect("demo:person-list")
+    else:
+        form = TransactionForm()
+    return render(
+        request, "demo/person_form.html", {"form": form, "title": "Add Transaction"}
+    )
+
+
+# --- API Support (DRF) ---
+
+
+class PersonViewSet(viewsets.ModelViewSet):
+    queryset = Person.objects.all()
+    serializer_class = PersonSerializer
+
+    # Sort and Search work automatically with BS date strings
+    filter_backends = [
+        django_filters.DjangoFilterBackend,
+        drf_filters.SearchFilter,
+        drf_filters.OrderingFilter,
+    ]
+
+    ordering_fields = ["birth_date", "created_at"]
+    search_fields = ["name", "birth_date", "phone_number"]
+
+    # Simple exact date filter
+    filterset_fields = {
+        "birth_date": ["exact"],
+    }
+
+    class PersonFilter(django_filters.FilterSet):
+        year = NepaliDateYearFilter(field_name="birth_date")
+        month = NepaliDateMonthFilter(field_name="birth_date")
+
+        class Meta:
+            model = Person
+            fields = ["province", "district"]
+
+    filterset_class = PersonFilter
+
+
+class CitizenViewSet(viewsets.ModelViewSet):
+    queryset = Citizen.objects.all()
+    serializer_class = CitizenSerializer
+    filter_backends = [drf_filters.OrderingFilter]
+    ordering_fields = ["province", "district"]
+
+
+class AuditedPersonViewSet(viewsets.ModelViewSet):
+    queryset = AuditedPerson.objects.all()
+    serializer_class = AuditedPersonSerializer
+    filter_backends = [drf_filters.SearchFilter, drf_filters.OrderingFilter]
+    search_fields = ["name", "birth_date"]
+    ordering_fields = ["created_at"]
+
+
+class TransactionViewSet(viewsets.ModelViewSet):
+    queryset = Transaction.objects.all()
+    serializer_class = TransactionSerializer
+    filter_backends = [django_filters.DjangoFilterBackend]
+
+    class TransactionFilter(django_filters.FilterSet):
+        amount_range = NepaliCurrencyRangeFilter(field_name="amount")
+        date_range = NepaliDateRangeFilter(field_name="date")
+
+        class Meta:
+            model = Transaction
+            fields = ["title", "amount", "date"]
+
+    filterset_class = TransactionFilter
+
+
+def address_normalize_demo(request):
+    address = request.GET.get("address", "")
+    result = None
+    if address:
+        result = normalize_address(address)
+
+    if request.headers.get("HX-Request") == "true":
+        return render(
+            request, "demo/address_normalize_partial.html", {"result": result}
+        )
+
+    return render(
+        request, "demo/address_normalize.html", {"address": address, "result": result}
+    )

example/example_project/settings.py

@@ -14,6 +14,8 @@ INSTALLED_APPS = [
     "django.contrib.messages",
     "django.contrib.staticfiles",
     "django_nepkit",
+    "rest_framework",
+    "django_filters",
     "demo",
 ]
 
@@ -73,4 +75,12 @@ TIME_ZONE = "Asia/Kathmandu"
 USE_I18N = True
 USE_TZ = True
 
+# django-nepkit settings
+NEPKIT = {
+    "DEFAULT_LANGUAGE": "en",  # Default to Devanagari for fields and widgets
+    "DATE_INPUT_FORMATS": ["%Y-%m-%d", "%d/%m/%Y", "%d-%m-%Y"],
+    "ADMIN_DATEPICKER": True,
+    "TIME_FORMAT": 12,  # 12-hour format with AM/PM
+}
+
 STATIC_URL = "static/"

example/example_project/urls.py

@@ -3,6 +3,6 @@ from django.urls import include, path
 
 urlpatterns = [
     path("admin/", admin.site.urls),
-    path("nepkit/", include("django_nepkit.urls")),
+    # path("nepkit/", include("django_nepkit.urls")),
     path("", include("demo.urls")),
 ]

example/manage.py

@@ -1,12 +1,12 @@
 #!/usr/bin/env python
-"""Django's command-line utility for administrative tasks."""
+"""Django utility for running commands."""
 
 import os
 import sys
 
 
 def main():
-    """Run administrative tasks."""
+    """Main entry point for Django commands."""
     sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example_project.settings")
     try:

django_nepkit/templatetags/nepali.py

@@ -1,74 +0,0 @@
-from django import template
-from nepali.datetime import nepalidate, nepalihumanize
-from nepali.number import nepalinumber
-import datetime
-
-register = template.Library()
-
-
-def _coerce_ad_date_to_bs(value):
-    """
-    Internal helper: if value is AD date/datetime, convert to `nepalidate`.
-    Does NOT attempt to parse strings (keeps template behavior minimal).
-    """
-    if isinstance(value, (datetime.datetime, datetime.date)):
-        return nepalidate.from_date(value)
-    return value
-
-
-@register.filter
-def nepali_date(value, format_str="%Y-%m-%d"):
-    """
-    Formats a date or datetime object into a Nepali date string.
-    """
-    if value is None:
-        return ""
-
-    value = _coerce_ad_date_to_bs(value)
-
-    if hasattr(value, "strftime"):
-        return value.strftime(format_str)
-    return value
-
-
-@register.filter
-def nepali_date_ne(value, format_str="%Y-%m-%d"):
-    """
-    Formats a date or datetime object into a Nepali date string (Devanagari).
-    """
-    if value is None:
-        return ""
-
-    value = _coerce_ad_date_to_bs(value)
-
-    if hasattr(value, "strftime_ne"):
-        return value.strftime_ne(format_str)
-    return value
-
-
-@register.filter
-def nepali_number(value):
-    """
-    Converts a number to Devanagari.
-    """
-    if value is None:
-        return ""
-    return nepalinumber(value).str_ne()
-
-
-@register.filter
-def nepali_humanize(value, threshold=None, format_str=None):
-    """
-    Returns a human-readable "time ago" string in Nepali.
-    """
-    if value is None:
-        return ""
-
-    # Threshold and format_str are optional
-    kwargs = {}
-    if threshold:
-        kwargs["threshold"] = threshold
-    if format_str:
-        kwargs["format"] = format_str
-
-    return nepalihumanize(value, **kwargs)