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

django_nepkit-0.1.0.dist-info/METADATA

@@ -1,377 +0,0 @@
-Metadata-Version: 2.4
-Name: django-nepkit
-Version: 0.1.0
-Summary: Django Nepali date, time, phone, and address fields with helpers.
-Home-page: https://github.com/S4NKALP/django-nepkit
-Author: Sankalp Tharu
-Author-email: Sankalp Tharu <sankalptharu50028@gmail.com>
-License: MIT
-Project-URL: Homepage, https://github.com/S4NKALP/django-nepkit
-Keywords: django,django-fields,django-forms,nepal,nepali,nepali-date,bikram-sambat,nepali-calendar,timezone,asia-kathmandu,phone-number,address,province,district,municipality
-Classifier: Framework :: Django
-Classifier: Framework :: Django :: 4.2
-Classifier: Framework :: Django :: 5.0
-Classifier: Framework :: Django :: 6.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Utilities
-Classifier: Operating System :: OS Independent
-Classifier: Natural Language :: English
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: django>=4.2
-Requires-Dist: nepali>=1.1.3
-Provides-Extra: drf
-Requires-Dist: djangorestframework>=3.14; extra == "drf"
-Dynamic: author
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: requires-python
-
-# django-nepkit
-
-<div align="center">
-
-<img src="https://img.shields.io/pypi/v/django-nepkit?color=blue&label=PyPI&logo=pypi&logoColor=white" alt="PyPI">
-<img src="https://img.shields.io/badge/Django-4.2%E2%80%936.0-0C4B33?logo=django&logoColor=white" alt="Django 4.2–6.0">
-<img src="https://img.shields.io/badge/Python-3.11%2B-3776AB?logo=python&logoColor=white" alt="Python">
-<a href="https://github.com/S4NKALP/django-nepkit/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"></a>
-
-</div>
-
-
-`django-nepkit` is a lightweight Django utility package for Nepali projects. It provides model fields, validators, and admin helpers for:
-
-- **Bikram Sambat (BS)** date, time, and datetime
-- **Nepali phone number** validation
-- **Chained address selects** (province → district → municipality)
-
-It also includes Django admin enhancements:
-
-- `NepaliModelAdmin` automatically wires the Nepali datepicker
-- `NepaliDateFilter` for filtering BS dates by year
-
-Optional Django REST Framework (DRF) serializer fields are available (install with `django-nepkit[drf]`).
-
-## Notes
-
-- The package depends on [`py-nepali`](https://github.com/opensource-nepal/py-nepali).
-- The date picker UI is implemented from [`sajanm/nepali-date-picker`](https://github.com/sajanm/nepali-date-picker).
-
----
-
-## Table of Contents
-
-- [Installation](#installation)
-- [Requirements](#requirements)
-- [Setup](#setup)
-- [Quick Start](#quick-start)
-- [Model Fields](#model-fields)
-- [Address Fields (Chained Selects)](#address-fields-chained-selects)
-- [Django Admin](#django-admin)
-- [Django REST Framework](#django-rest-framework)
-- [Public API](#public-api)
-- [Contributing](#contributing)
-- [License](#license)
-
----
-
-## Installation
-
-```bash
-pip install django-nepkit
-```
-
-### Optional: DRF Serializer Fields
-
-```bash
-pip install "django-nepkit[drf]"
-```
-
----
-
-## Requirements
-
-- Python `>=3.11`
-- Django `>=4.2`
-- `nepali>=1.1.3`
-
----
-
-## Setup
-
-### Add to `INSTALLED_APPS`
-
-```python
-INSTALLED_APPS = [
-    # ...
-    "django.contrib.staticfiles",
-    "django_nepkit",
-]
-```
-
----
-
-## Quick Start
-
-```python
-# models.py
-from django.db import models
-from django_nepkit import NepaliDateField, NepaliDateTimeField, NepaliPhoneNumberField
-
-class Person(models.Model):
-    name = models.CharField(max_length=100)
-    birth_date = NepaliDateField()
-    created_at = NepaliDateTimeField(auto_now_add=True)
-    phone_number = NepaliPhoneNumberField()
-```
-
-```python
-# admin.py
-from django.contrib import admin
-from django_nepkit import NepaliModelAdmin
-from .models import Person
-
-@admin.register(Person)
-class PersonAdmin(NepaliModelAdmin):
-    list_display = ("name", "birth_date", "created_at", "phone_number")
-```
-
-`NepaliModelAdmin` automatically loads the Nepali datepicker assets and applies the widget—no custom forms required.
-
----
-
-## Model Fields
-
-### `NepaliDateField` (BS date)
-
-Stores a BS date in the DB as a string (`YYYY-MM-DD`). In Python, it returns/accepts `nepali.datetime.nepalidate`.
-
-```python
-from django_nepkit import NepaliDateField
-
-class Event(models.Model):
-    event_date = NepaliDateField()
-```
-
-**Notes:**
-
-- Stored as a string, not SQL DATE
-- Accepts BS strings like `"2081-10-15"`, `nepalidate`, and AD `datetime.date` (converted to BS)
-
----
-
-### `NepaliDateTimeField` (BS datetime)
-
-Stores a BS datetime string (`YYYY-MM-DD HH:MM:SS`) in the DB and uses `nepalidatetime` in Python.
-
-```python
-from django_nepkit import NepaliDateTimeField
-
-class Log(models.Model):
-    created_at = NepaliDateTimeField(auto_now_add=True)
-    updated_at = NepaliDateTimeField(auto_now=True)
-```
-
----
-
-### `NepaliTimeField`
-
-A normal Django `TimeField` for consistency.
-
-```python
-from django_nepkit import NepaliTimeField
-
-class Shift(models.Model):
-    start_time = NepaliTimeField()
-```
-
----
-
-### `NepaliPhoneNumberField`
-
-A `CharField` with Nepali phone number validation.
-
-```python
-from django_nepkit import NepaliPhoneNumberField
-
-class Contact(models.Model):
-    phone_number = NepaliPhoneNumberField()
-```
-
----
-
-## Address Fields (Chained Selects)
-
-Chained fields: province → district → municipality.
-
-```python
-from django.db import models
-from django_nepkit import ProvinceField, DistrictField, MunicipalityField
-
-class Address(models.Model):
-    province = ProvinceField()
-    district = DistrictField()
-    municipality = MunicipalityField()
-```
-
-### URLs required for chaining
-
-```python
-# urls.py
-from django.urls import include, path
-
-urlpatterns = [
-    # ...
-    path("nepkit/", include("django_nepkit.urls")),
-]
-```
-
----
-
-## Django Admin
-
-### `NepaliModelAdmin`
-
-- Auto-wires datepicker for BS fields
-- Provides `format_nepali_date(...)` and `format_nepali_datetime(...)`
-- Includes `NepaliDateFilter`
-
-```python
-from django.contrib import admin
-from django_nepkit import NepaliModelAdmin
-
-@admin.register(MyModel)
-class MyModelAdmin(NepaliModelAdmin):
-    pass
-```
-
-### `NepaliDateFilter`
-
-Filter `NepaliDateField` by BS year:
-
-```python
-from django_nepkit import NepaliDateFilter, NepaliModelAdmin
-
-@admin.register(MyModel)
-class MyModelAdmin(NepaliModelAdmin):
-    list_filter = (("my_nepali_date_field", NepaliDateFilter),)
-```
-
-**Datepicker assets used:**
-
-- JS: `https://nepalidatepicker.sajanmaharjan.com.np/v5/nepali.datepicker/js/nepali.datepicker.v5.0.6.min.js`
-- CSS: `https://nepalidatepicker.sajanmaharjan.com.np/v5/nepali.datepicker/css/nepali.datepicker.v5.0.6.min.css`
-
----
-
-## Django REST Framework
-
-Install the extra:
-
-```bash
-pip install "django-nepkit[drf]"
-```
-
-### `NepaliDateSerializerField`
-
-```python
-from rest_framework import serializers
-from django_nepkit.serializers import NepaliDateSerializerField
-
-class PersonSerializer(serializers.Serializer):
-    birth_date = NepaliDateSerializerField(format="%Y/%m/%d")
-```
-
-### `NepaliDateTimeSerializerField`
-
-```python
-from rest_framework import serializers
-from django_nepkit.serializers import NepaliDateTimeSerializerField
-
-class LogSerializer(serializers.Serializer):
-    created_at = NepaliDateTimeSerializerField()
-```
-
----
-
-## Public API
-
-```python
-from django_nepkit import (
-    NepaliDateField,
-    NepaliTimeField,
-    NepaliDateTimeField,
-    NepaliPhoneNumberField,
-    ProvinceField,
-    DistrictField,
-    MunicipalityField,
-    NepaliDateFilter,
-    NepaliModelAdmin,
-    NepaliAdminMixin,
-)
-```
-
-DRF fields live in `django_nepkit.serializers`.
-
----
-
-## Contributing
-
-Contributions are welcome. If you find a bug or want an improvement, please open an issue or submit a pull request.
-
-### Local setup
-
-Clone the repo and install dependencies (this project uses `uv`):
-
-```bash
-git clone <your-fork-url>
-cd prod-django-nepkit
-uv sync
-```
-
-### Run the example project
-
-The repository contains an example Django project under `example/`.
-
-```bash
-cd example
-uv run manage.py migrate
-uv run manage.py createsuperuser
-uv run manage.py runserver
-```
-
-### Code quality (recommended before every commit)
-
-Install and run pre-commit:
-
-```bash
-uv run pre-commit install
-uv run pre-commit run --all-files
-```
-
-You can also run Ruff directly:
-
-```bash
-uv run ruff format .
-uv run ruff check .
-```
-
-### Pull request guidelines
-
-- Keep PRs focused and small when possible.
-- Update `README.md` if behavior or public API changes.
-- If you add a new feature, include a minimal example and tests if applicable.
-
----
-
-## License
-
-MIT. See [`LICENSE`](LICENSE).

django_nepkit-0.1.0.dist-info/RECORD

@@ -1,39 +0,0 @@
-django_nepkit/__init__.py,sha256=SS1Niv5hCLvv3r0-gJSrRP9AnjyP7uetJivZxc6kYPA,634
-django_nepkit/admin.py,sha256=EfGvOZ12slKBryjjYLYDeh5dV3ngS9LtJmr9EbarC4E,7282
-django_nepkit/forms.py,sha256=3FGjQK0UTWdkLByq_FvoGfcwq-NSL5nmgq4aerheDq8,1498
-django_nepkit/models.py,sha256=i_PBixP7o5V9lsYGAeH3_f18WTab2Mp9rgEH_NUNr_c,8991
-django_nepkit/serializers.py,sha256=zu-ZwaCZ0Lxv_WJpp_L4GNqAGp6ZWKWNzYGj0DcyUII,3284
-django_nepkit/urls.py,sha256=mPF_xEaOqNrInggBhUbwwMq-FTR7rJ0CfT0fQPx41t8,297
-django_nepkit/utils.py,sha256=4r-S_8_5wXvn1e8K7nmuBTnnsqpsmJlaKv3URNg25VA,2199
-django_nepkit/validators.py,sha256=mBIAF1M9pnoQ0zAkNyFhZb3avr_pg5YeXDfotfyLt2c,422
-django_nepkit/views.py,sha256=qkCNBwH5hsX3uymDRj0aH72jSdvwx9QCEEkaMP-9BmA,614
-django_nepkit/widgets.py,sha256=f-bUSTgB3t2VS3EBsA2qM-Vkj0T2EuOTTLYIS4PpY2Y,2468
-django_nepkit/static/django_nepkit/css/admin-nepali-datepicker.css,sha256=g9ago3O0UfoNwRD02AmWSdxiHmXxkQ7mpi94Nn1rO3E,834
-django_nepkit/static/django_nepkit/js/address-chaining.js,sha256=HRH0NxjwfDkFFbdH0ZbjCkEx4fv77gnj2s2leB0nlE0,2522
-django_nepkit/static/django_nepkit/js/admin-jquery-bridge.js,sha256=6iqIuSqgYssKtt61WSjye3GBpYHh3AKKYUtGL6Uh3S8,319
-django_nepkit/static/django_nepkit/js/nepali-datepicker-init.js,sha256=qtQrL58L-kTsyBU1LS0_3y4fCmJOzYt1e3ooFNSSadw,3909
-django_nepkit/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_nepkit/templatetags/nepali.py,sha256=NDapVDZ-pPCENotb4BbSYSlDJml3IIaN_QHBw8iO-B0,1754
-django_nepkit-0.1.0.dist-info/licenses/LICENSE,sha256=76985cvIL0AXuhZd5L2C9tbdxKMZX7IOejjvZI8kXMo,1070
-example/manage.py,sha256=icTnUNJM8dPiIPymP7fVQJvmGGql9e10-A-FjOwXAyM,759
-example/demo/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-example/demo/admin.py,sha256=Qh-SIMjvt6ACHgrPpVjjqbLgZqkn_9z_k2xD_MblNqw,1298
-example/demo/apps.py,sha256=sXxYSi4dEGg-HDkM7C-TfLv26KbSUj-8HTeFS86pW8w,83
-example/demo/models.py,sha256=xAH5b2nVrjsqp1fR3bu4MQ_-hLbwtB8rX4TpSnnpbGE,709
-example/demo/tests.py,sha256=qWDvA9ZhVCQ1rPbkoFify7o_fDirXMUdYMxF12q3WIM,26
-example/demo/urls.py,sha256=soELX6XOYW9xacM9FUSm6URPOrVHkSpxnQU3TMhFXkw,201
-example/demo/views.py,sha256=cqj-6RkfGBRht35725M7IhPd-BN7y-wnd7ZecYCXLyM,799
-example/demo/migrations/0001_initial.py,sha256=9e2UZ-XvVk3Vba04DcgZmE9uCeB6Er9LxWtEMHhuY98,112619
-example/demo/migrations/0002_alter_person_phone_number.py,sha256=1UU5udaEew4LieB-_X8LsEJpQaKKzA1FGpkzgQjCA4E,424
-example/demo/migrations/0003_person_created_at_person_updated_at.py,sha256=N8FLAHnISLx9mm9QFK5HaCirHsjW7RfCxoVNka9-pQg,740
-example/demo/migrations/0004_alter_person_created_at_alter_person_updated_at.py,sha256=Mr5angejtb6pUykeVBBNB8q5pGbYMJkc3hfU27PX-4E,624
-example/demo/migrations/0005_alter_person_created_at_alter_person_updated_at.py,sha256=8COnCVVeJWmZZYBwdcfJBm8NP6J27khlOf764f0-ZG0,790
-example/demo/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-example/example_project/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-example/example_project/settings.py,sha256=huK0oAus70wAC9n6-wEIzu7m5Qh2-qGfT45TK2fW1l0,2027
-example/example_project/urls.py,sha256=vIUjmCBA6lUUhS13J0iM_hrMvP78AL7E_xZNJP0If5U,215
-example/example_project/wsgi.py,sha256=OK4x37NxQNVNWV4ynLqWP546tR4eALIFn7pyHc8XDNw,176
-django_nepkit-0.1.0.dist-info/METADATA,sha256=YtWwMo5TVCFSYrvdEwbVCe_TpSWtNZbIkuZucvgahGE,8887
-django_nepkit-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-django_nepkit-0.1.0.dist-info/top_level.txt,sha256=Rs68WqPeyCvsWQStPNLl6vu10wCIfrFrc7xhkRcFzss,22
-django_nepkit-0.1.0.dist-info/RECORD,,