django-chelseru 1.0.4__tar.gz → 1.0.6__tar.gz

django_chelseru-1.0.6/PKG-INFO

@@ -0,0 +1,312 @@
+Metadata-Version: 2.4
+Name: django-chelseru
+Version: 1.0.6
+Summary: Authentication system, online and real-time chat, SMS system for Iranian SMS services.
+Home-page: https://pipdjango.chelseru.com
+Author: Sobhan Bahman|Rashnu
+Author-email: bahmanrashnu@gmail.com
+Project-URL: Documentation, https://github.com/Chelseru/django-chelseru-lour/
+Project-URL: Telegram Group, https://t.me/bahmanpy
+Project-URL: Telegram Channel, https://t.me/ChelseruCom
+Keywords: djangochelseruchat djangochat drfchat online-chat online real-time chat iran chelseru lor lur bahman rashnu lour sms djangoauth auth ywt otpauth otp authentication djangootp djangoiransms iransms djangosms djangokavenegar djangomelipayamak sobhan چت  سبحان بهمن رشنو چلسرو جنگو پایتون لر لور آنلاین ریل تایم
+Classifier: Programming Language :: Python :: 3
+Classifier: Framework :: Django
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=5.1.6
+Requires-Dist: djangorestframework==3.15.2
+Requires-Dist: djangorestframework_simplejwt==5.5.0
+Requires-Dist: channels==4.2.2
+Requires-Dist: channels_redis==4.2.1
+Requires-Dist: daphne==4.1.2
+Requires-Dist: zeep==4.3.1
+Requires-Dist: user-agents==2.2.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# django-chelseru
+
+بستهٔ جنگویی برای **گپ‌زنی همزمان (WebSocket)**، **راستی‌آزمایی پیامکی (OTP)** و **فرستادن پیامک** با یاری‌دهنده‌های ایرانی.
+
+**نویسنده:** Sobhan Bahman Rashnu
+
+---
+
+## فهرست مطالب
+
+- [ویژگی‌ها](#ویژگیها)
+- [نصب](#نصب)
+- [پیش‌نیازها و افزودن به تنظیمات](#پیشنیازها-و-افزودن-به-تنظیمات)
+- [پیکربندی](#پیکربندی)
+- [تعریف آدرس‌ها (URLs)](#تعریف-آدرسها-urls)
+- [نقطه‌های پایانی API](#نقطههای-پایانی-api)
+  - [/api/otp/send/ — فرستادن رمز یک‌بارمصرف](#apiotpsend--فرستادن-رمز-یکبارمصرف)
+  - [/api/authenticate/ — راستی‌آزمایی با OTP و دریافت JWT](#apiauthenticate--راستیآزمایی-با-otp-و-دریافت-jwt)
+  - [/api/message/send/ — فرستادن پیامک](#apimessagesend--فرستادن-پیامک)
+  - [/api/sessions/ — فهرست نشست‌های فعال](#apisessions--فهرست-نشستهای-فعال)
+- [مدل‌ها](#مدلها)
+
+---
+
+## ویژگی‌ها
+
+- 📱 **راستی‌آزمایی پیامکی (OTP):** تولید و فرستادن رمز یک‌بارمصرف و اعتبارسنجی امن.
+- 💬 **گپ‌زنی همزمان:** پیام‌رسانی همزمان بر پایهٔ **WebSocket/Channels**.
+- ✉️ **فرستادن پیامک:** پشتیبانی از یاری‌دهنده‌های نام‌آشنای ایرانی.
+
+---
+
+## نصب
+
+```bash
+pip install django-chelseru
+```
+
+---
+
+## پیش‌نیازها و افزودن به تنظیمات
+
+`INSTALLED_APPS` را در `settings.py` به‌روز کنید:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    'channels',
+    'rest_framework',
+    'rest_framework_simplejwt',
+    'drfchelseru',
+    # ...
+]
+```
+
+> نکته: برای قابلیت‌های همزمان (WebSocket) پروژهٔ شما باید با **ASGI** اجرا شود (مانند `daphne` یا `uvicorn`).
+
+---
+
+## پیکربندی
+
+واژه‌نامهٔ `DJANGO_CHELSERU` را در `settings.py` بیفزایید و بر اساس نیاز خود سفارشی‌سازی کنید:
+
+```python
+DJANGO_CHELSERU = {
+    'AUTH': {
+        'AUTH_METHOD': 'OTP',  # روش‌های پشتیبانی‌شده: OTP, PASSWD
+        'AUTH_SERVICE': 'rest_framework_simplejwt',  # فعلاً: rest_framework_simplejwt
+        'OPTIONS': {
+            'OTP_LENGTH': 8,                 # پیش‌فرض: 8
+            'OTP_EXPIRE_PER_MINUTES': 4,     # پیش‌فرض: 4
+            'OTP_SMS_TEMPLATE_ID': 1,        # شناسهٔ قالب پیامکی OTP
+        },
+    },
+    'SMS': {
+        'SMS_SERVICE': 'PARSIAN_WEBCO_IR',  # PARSIAN_WEBCO_IR, MELI_PAYAMAK_COM, KAVENEGAR_COM
+        'SETTINGS': {
+            'PARSIAN_WEBCO_IR_API_KEY': '',
+            'MELI_PAYAMAK_COM_USERNAME': '',
+            'MELI_PAYAMAK_COM_PASSWORD': '',
+            'MELI_PAYAMAK_COM_FROM': '',
+            'KAVENEGAR_COM_API_KEY': 'YOUR_KAVENEGAR_API_KEY',
+            'KAVENEGAR_COM_FROM': 'YOUR_KAVENEGAR_FROM_NUMBER',
+        },
+        'TEMPLATES': {
+            'T1': 1,
+            'T2': 2,
+            # ...
+        },
+    },
+}
+```
+
+**راهنما:**
+
+- `AUTH_METHOD`: روش راستی‌آزمایی (برای پیامکی از `'OTP'` استفاده کنید).
+- `OTP_LENGTH`: طول رمز یک‌بارمصرف.
+- `OTP_EXPIRE_PER_MINUTES`: مدت اعتبار رمز (به دقیقه).
+- `OTP_SMS_TEMPLATE_ID`: شناسهٔ قالب پیامکی که برای OTP بهره‌گیری می‌شود.
+- `SMS_SERVICE`: انتخاب یاری‌دهندهٔ پیامکی.
+- `SETTINGS`: مقادیر دسترسی یاری‌دهندهٔ انتخاب‌شده.
+- `TEMPLATES`: نگاشت کلیدهای دلخواه به شناسهٔ قالب‌ها.
+
+---
+
+## تعریف آدرس‌ها (URLs)
+
+در `urls.py`:
+
+```python
+from django.urls import path, include
+
+urlpatterns = [
+    # ...
+    path('api/', include('drfchelseru.urls')),
+    # ...
+]
+```
+
+---
+
+## نقطه‌های پایانی API
+
+| مسیر                 | شرح                                                | روش  |
+| -------------------- | -------------------------------------------------- | ---- |
+| `/api/otp/send/`     | فرستادن رمز یک‌بارمصرف به شمارهٔ همراه             | POST |
+| `/api/authenticate/` | راستی‌آزمایی کاربر با OTP و دریافت توکن‌های JWT    | POST |
+| `/api/sessions/`     | فهرست و مدیریت نشست‌های فعال کاربر (نیازمند احراز) | GET  |
+| `/api/message/send/` | فرستادن پیامک با یاری‌دهندهٔ پیکربندی‌شده          | POST |
+
+---
+
+### `/api/otp/send/` — فرستادن رمز یک‌بارمصرف
+
+**روش:** `POST`\
+**شرح:** یک OTP به شمارهٔ همراه کاربر فرستاده می‌شود.
+
+**بدنهٔ درخواست:**
+
+| فیلد            | نوع   | شرح                | نمونه         |
+| --------------- | ----- | ------------------ | ------------- |
+| `mobile_number` | `str` | شمارهٔ همراه کاربر | `09121234567` |
+
+**نمونهٔ درخواست:**
+
+```http
+POST /api/otp/send/ HTTP/1.1
+Content-Type: application/json
+
+{
+  "mobile_number": "09121234567"
+}
+```
+
+**پاسخ‌های ممکن:**
+
+- `200 OK`
+  ```json
+  { "details": "The OTP code was sent correctly." }
+  ```
+- `400 Bad Request` — ساختار نادرست `mobile_number`
+- `409 Conflict`
+  ```json
+  { "details": "An OTP code has already been sent. Please wait X seconds before trying again." }
+  ```
+- `500 Internal Server Error` — خطا در کارگذار
+
+---
+
+### `/api/authenticate/` — راستی‌آزمایی با OTP و دریافت JWT
+
+**روش:** `POST`\
+**شرح:** اعتبارسنجی کاربر با OTP؛ در صورت موفقیت، توکن‌های `access` و `refresh` بازگردانده می‌شود.
+
+**بدنهٔ درخواست:**
+
+| فیلد            | نوع   | شرح                         | نمونه         |
+| --------------- | ----- | --------------------------- | ------------- |
+| `mobile_number` | `str` | شمارهٔ همراه کاربر          | `09121234567` |
+| `code`          | `str` | رمز یک‌بارمصرف دریافت‌شده   | `12345678`    |
+| `group`         | `int` | (اختیاری) شناسهٔ گروه کاربر | `1`           |
+
+**نمونهٔ درخواست:**
+
+```http
+POST /api/authenticate/ HTTP/1.1
+Content-Type: application/json
+
+{
+  "mobile_number": "09121234567",
+  "code": "12345678",
+  "group": 1
+}
+```
+
+**پاسخ‌های ممکن:**
+
+- `200 OK`
+  ```json
+  { "access": "...", "refresh": "..." }
+  ```
+- `401 Unauthorized`
+  ```json
+  { "error": "The code sent to this mobile number was not found." }
+  ```
+- `400 Bad Request` — فیلدهای الزامی ناپیدا/نامعتبر
+- `500 Internal Server Error` — خطا در کارگذار
+
+---
+
+### `/api/message/send/` — فرستادن پیامک
+
+**روش:** `POST`\
+**شرح:** فرستادن پیامک سفارشی با یاری‌دهندهٔ پیکربندی‌شده.
+
+**بدنهٔ درخواست:**
+
+| فیلد            | نوع   | شرح                                            | نمونه           |
+| --------------- | ----- | ---------------------------------------------- | --------------- |
+| `mobile_number` | `str` | شمارهٔ همراه گیرنده                            | `09121234567`   |
+| `message_text`  | `str` | متن پیام (حداکثر ۲۹۰ نویسه)                    | `Hello, World!` |
+| `template_id`   | `int` | (برای برخی یاری‌دهنده‌ها مانند پارسیان الزامی) | `1`             |
+
+**نمونهٔ درخواست:**
+
+```http
+POST /api/message/send/ HTTP/1.1
+Content-Type: application/json
+
+{
+  "mobile_number": "09121234567",
+  "message_text": "Hello, World!",
+  "template_id": 1
+}
+```
+
+**پاسخ‌های ممکن:**
+
+- `200 OK`
+  ```json
+  { "details": "The Message was sent correctly." }
+  ```
+- `400 Bad Request` — خطاهای اعتبارسنجی فیلدها
+- `401 Unauthorized` — احراز انجام نشده
+- `500 Internal Server Error` — خطا در کارگذار
+- `502 Bad Gateway` — خطای بازگشتی از یاری‌دهندهٔ پیامکی
+
+---
+
+### `/api/sessions/` — فهرست نشست‌های فعال
+
+**روش:** `GET`\
+**شرح:** همهٔ نشست‌های فعال کاربر را برمی‌گرداند. نیازمند **احراز هویت** (`IsAuthenticated`).
+
+**سربرگ‌های لازم:**
+
+| سربرگ           | مقدار                        |
+| --------------- | ---------------------------- |
+| `Authorization` | `Bearer <your_access_token>` |
+
+**نمونهٔ درخواست:**
+
+```http
+GET /api/sessions/ HTTP/1.1
+Authorization: Bearer <your_access_token>
+```
+
+---
+
+## مدل‌ها
+
+این بسته یک مدل **Session** برای مدیریت نشست‌های فعال کاربران فراهم می‌کند.\
+از طریق نقطهٔ پایانی `/api/sessions/` می‌توانید نشست‌ها را مشاهده/مدیریت کنید.

django_chelseru-1.0.6/README.md

@@ -0,0 +1,273 @@
+# django-chelseru
+
+بستهٔ جنگویی برای **گپ‌زنی همزمان (WebSocket)**، **راستی‌آزمایی پیامکی (OTP)** و **فرستادن پیامک** با یاری‌دهنده‌های ایرانی.
+
+**نویسنده:** Sobhan Bahman Rashnu
+
+---
+
+## فهرست مطالب
+
+- [ویژگی‌ها](#ویژگیها)
+- [نصب](#نصب)
+- [پیش‌نیازها و افزودن به تنظیمات](#پیشنیازها-و-افزودن-به-تنظیمات)
+- [پیکربندی](#پیکربندی)
+- [تعریف آدرس‌ها (URLs)](#تعریف-آدرسها-urls)
+- [نقطه‌های پایانی API](#نقطههای-پایانی-api)
+  - [/api/otp/send/ — فرستادن رمز یک‌بارمصرف](#apiotpsend--فرستادن-رمز-یکبارمصرف)
+  - [/api/authenticate/ — راستی‌آزمایی با OTP و دریافت JWT](#apiauthenticate--راستیآزمایی-با-otp-و-دریافت-jwt)
+  - [/api/message/send/ — فرستادن پیامک](#apimessagesend--فرستادن-پیامک)
+  - [/api/sessions/ — فهرست نشست‌های فعال](#apisessions--فهرست-نشستهای-فعال)
+- [مدل‌ها](#مدلها)
+
+---
+
+## ویژگی‌ها
+
+- 📱 **راستی‌آزمایی پیامکی (OTP):** تولید و فرستادن رمز یک‌بارمصرف و اعتبارسنجی امن.
+- 💬 **گپ‌زنی همزمان:** پیام‌رسانی همزمان بر پایهٔ **WebSocket/Channels**.
+- ✉️ **فرستادن پیامک:** پشتیبانی از یاری‌دهنده‌های نام‌آشنای ایرانی.
+
+---
+
+## نصب
+
+```bash
+pip install django-chelseru
+```
+
+---
+
+## پیش‌نیازها و افزودن به تنظیمات
+
+`INSTALLED_APPS` را در `settings.py` به‌روز کنید:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    'channels',
+    'rest_framework',
+    'rest_framework_simplejwt',
+    'drfchelseru',
+    # ...
+]
+```
+
+> نکته: برای قابلیت‌های همزمان (WebSocket) پروژهٔ شما باید با **ASGI** اجرا شود (مانند `daphne` یا `uvicorn`).
+
+---
+
+## پیکربندی
+
+واژه‌نامهٔ `DJANGO_CHELSERU` را در `settings.py` بیفزایید و بر اساس نیاز خود سفارشی‌سازی کنید:
+
+```python
+DJANGO_CHELSERU = {
+    'AUTH': {
+        'AUTH_METHOD': 'OTP',  # روش‌های پشتیبانی‌شده: OTP, PASSWD
+        'AUTH_SERVICE': 'rest_framework_simplejwt',  # فعلاً: rest_framework_simplejwt
+        'OPTIONS': {
+            'OTP_LENGTH': 8,                 # پیش‌فرض: 8
+            'OTP_EXPIRE_PER_MINUTES': 4,     # پیش‌فرض: 4
+            'OTP_SMS_TEMPLATE_ID': 1,        # شناسهٔ قالب پیامکی OTP
+        },
+    },
+    'SMS': {
+        'SMS_SERVICE': 'PARSIAN_WEBCO_IR',  # PARSIAN_WEBCO_IR, MELI_PAYAMAK_COM, KAVENEGAR_COM
+        'SETTINGS': {
+            'PARSIAN_WEBCO_IR_API_KEY': '',
+            'MELI_PAYAMAK_COM_USERNAME': '',
+            'MELI_PAYAMAK_COM_PASSWORD': '',
+            'MELI_PAYAMAK_COM_FROM': '',
+            'KAVENEGAR_COM_API_KEY': 'YOUR_KAVENEGAR_API_KEY',
+            'KAVENEGAR_COM_FROM': 'YOUR_KAVENEGAR_FROM_NUMBER',
+        },
+        'TEMPLATES': {
+            'T1': 1,
+            'T2': 2,
+            # ...
+        },
+    },
+}
+```
+
+**راهنما:**
+
+- `AUTH_METHOD`: روش راستی‌آزمایی (برای پیامکی از `'OTP'` استفاده کنید).
+- `OTP_LENGTH`: طول رمز یک‌بارمصرف.
+- `OTP_EXPIRE_PER_MINUTES`: مدت اعتبار رمز (به دقیقه).
+- `OTP_SMS_TEMPLATE_ID`: شناسهٔ قالب پیامکی که برای OTP بهره‌گیری می‌شود.
+- `SMS_SERVICE`: انتخاب یاری‌دهندهٔ پیامکی.
+- `SETTINGS`: مقادیر دسترسی یاری‌دهندهٔ انتخاب‌شده.
+- `TEMPLATES`: نگاشت کلیدهای دلخواه به شناسهٔ قالب‌ها.
+
+---
+
+## تعریف آدرس‌ها (URLs)
+
+در `urls.py`:
+
+```python
+from django.urls import path, include
+
+urlpatterns = [
+    # ...
+    path('api/', include('drfchelseru.urls')),
+    # ...
+]
+```
+
+---
+
+## نقطه‌های پایانی API
+
+| مسیر                 | شرح                                                | روش  |
+| -------------------- | -------------------------------------------------- | ---- |
+| `/api/otp/send/`     | فرستادن رمز یک‌بارمصرف به شمارهٔ همراه             | POST |
+| `/api/authenticate/` | راستی‌آزمایی کاربر با OTP و دریافت توکن‌های JWT    | POST |
+| `/api/sessions/`     | فهرست و مدیریت نشست‌های فعال کاربر (نیازمند احراز) | GET  |
+| `/api/message/send/` | فرستادن پیامک با یاری‌دهندهٔ پیکربندی‌شده          | POST |
+
+---
+
+### `/api/otp/send/` — فرستادن رمز یک‌بارمصرف
+
+**روش:** `POST`\
+**شرح:** یک OTP به شمارهٔ همراه کاربر فرستاده می‌شود.
+
+**بدنهٔ درخواست:**
+
+| فیلد            | نوع   | شرح                | نمونه         |
+| --------------- | ----- | ------------------ | ------------- |
+| `mobile_number` | `str` | شمارهٔ همراه کاربر | `09121234567` |
+
+**نمونهٔ درخواست:**
+
+```http
+POST /api/otp/send/ HTTP/1.1
+Content-Type: application/json
+
+{
+  "mobile_number": "09121234567"
+}
+```
+
+**پاسخ‌های ممکن:**
+
+- `200 OK`
+  ```json
+  { "details": "The OTP code was sent correctly." }
+  ```
+- `400 Bad Request` — ساختار نادرست `mobile_number`
+- `409 Conflict`
+  ```json
+  { "details": "An OTP code has already been sent. Please wait X seconds before trying again." }
+  ```
+- `500 Internal Server Error` — خطا در کارگذار
+
+---
+
+### `/api/authenticate/` — راستی‌آزمایی با OTP و دریافت JWT
+
+**روش:** `POST`\
+**شرح:** اعتبارسنجی کاربر با OTP؛ در صورت موفقیت، توکن‌های `access` و `refresh` بازگردانده می‌شود.
+
+**بدنهٔ درخواست:**
+
+| فیلد            | نوع   | شرح                         | نمونه         |
+| --------------- | ----- | --------------------------- | ------------- |
+| `mobile_number` | `str` | شمارهٔ همراه کاربر          | `09121234567` |
+| `code`          | `str` | رمز یک‌بارمصرف دریافت‌شده   | `12345678`    |
+| `group`         | `int` | (اختیاری) شناسهٔ گروه کاربر | `1`           |
+
+**نمونهٔ درخواست:**
+
+```http
+POST /api/authenticate/ HTTP/1.1
+Content-Type: application/json
+
+{
+  "mobile_number": "09121234567",
+  "code": "12345678",
+  "group": 1
+}
+```
+
+**پاسخ‌های ممکن:**
+
+- `200 OK`
+  ```json
+  { "access": "...", "refresh": "..." }
+  ```
+- `401 Unauthorized`
+  ```json
+  { "error": "The code sent to this mobile number was not found." }
+  ```
+- `400 Bad Request` — فیلدهای الزامی ناپیدا/نامعتبر
+- `500 Internal Server Error` — خطا در کارگذار
+
+---
+
+### `/api/message/send/` — فرستادن پیامک
+
+**روش:** `POST`\
+**شرح:** فرستادن پیامک سفارشی با یاری‌دهندهٔ پیکربندی‌شده.
+
+**بدنهٔ درخواست:**
+
+| فیلد            | نوع   | شرح                                            | نمونه           |
+| --------------- | ----- | ---------------------------------------------- | --------------- |
+| `mobile_number` | `str` | شمارهٔ همراه گیرنده                            | `09121234567`   |
+| `message_text`  | `str` | متن پیام (حداکثر ۲۹۰ نویسه)                    | `Hello, World!` |
+| `template_id`   | `int` | (برای برخی یاری‌دهنده‌ها مانند پارسیان الزامی) | `1`             |
+
+**نمونهٔ درخواست:**
+
+```http
+POST /api/message/send/ HTTP/1.1
+Content-Type: application/json
+
+{
+  "mobile_number": "09121234567",
+  "message_text": "Hello, World!",
+  "template_id": 1
+}
+```
+
+**پاسخ‌های ممکن:**
+
+- `200 OK`
+  ```json
+  { "details": "The Message was sent correctly." }
+  ```
+- `400 Bad Request` — خطاهای اعتبارسنجی فیلدها
+- `401 Unauthorized` — احراز انجام نشده
+- `500 Internal Server Error` — خطا در کارگذار
+- `502 Bad Gateway` — خطای بازگشتی از یاری‌دهندهٔ پیامکی
+
+---
+
+### `/api/sessions/` — فهرست نشست‌های فعال
+
+**روش:** `GET`\
+**شرح:** همهٔ نشست‌های فعال کاربر را برمی‌گرداند. نیازمند **احراز هویت** (`IsAuthenticated`).
+
+**سربرگ‌های لازم:**
+
+| سربرگ           | مقدار                        |
+| --------------- | ---------------------------- |
+| `Authorization` | `Bearer <your_access_token>` |
+
+**نمونهٔ درخواست:**
+
+```http
+GET /api/sessions/ HTTP/1.1
+Authorization: Bearer <your_access_token>
+```
+
+---
+
+## مدل‌ها
+
+این بسته یک مدل **Session** برای مدیریت نشست‌های فعال کاربران فراهم می‌کند.\
+از طریق نقطهٔ پایانی `/api/sessions/` می‌توانید نشست‌ها را مشاهده/مدیریت کنید.