use dry principle possible and added example project

Author: S4NKALP

.github/workflows/pre-commit.yml

@@ -0,0 +1,26 @@
+name: pre-commit
+
+on: [push, pull_request]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run pre-commit
+        run: uv run pre-commit run --all-files --show-diff-on-failure

.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Publish to PyPI
+on:
+  release:
+    types: [published]
+permissions:
+  contents: read
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.10'
+        cache: 'pip'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+    - name: Build package
+      run: python -m build
+    - name: Publish package to PyPI
+      run: python -m twine upload dist/* --verbose

.gitignore

@@ -182,9 +182,9 @@ cython_debug/
 .abstra/
 
 # Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
 #  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
 #  you could uncomment the following to ignore the entire vscode folder
 # .vscode/
 

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: check-toml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-added-large-files
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.14
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+

MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include README.md
+recursive-include django_nepkit/static *

README.md

@@ -0,0 +1,13 @@
+## Installation
+
+```bash
+pip install django-nepkit
+```
+
+### Optional: Django REST Framework support
+
+If you want serializer fields from `django_nepkit.serializers`, install the extra:
+
+```bash
+pip install "django-nepkit[drf]"
+```

Untitled

@@ -0,0 +1,31 @@
+from .models import (
+    NepaliDateField,
+    NepaliTimeField,
+    NepaliDateTimeField,
+    NepaliPhoneNumberField,
+    ProvinceField,
+    DistrictField,
+    MunicipalityField,
+)
+from .admin import (
+    NepaliDateFilter,
+    format_nepali_date,
+    format_nepali_datetime,
+    NepaliModelAdmin,
+    NepaliAdminMixin,
+)
+
+__all__ = [
+    "NepaliDateField",
+    "NepaliTimeField",
+    "NepaliDateTimeField",
+    "NepaliPhoneNumberField",
+    "ProvinceField",
+    "DistrictField",
+    "MunicipalityField",
+    "NepaliDateFilter",
+    "format_nepali_date",
+    "format_nepali_datetime",
+    "NepaliModelAdmin",
+    "NepaliAdminMixin",
+]