paytechuz 0.1.0__tar.gz

paytechuz-0.1.0/MANIFEST.in

@@ -0,0 +1,16 @@
+include LICENSE
+include README.md
+include PYPI_UPLOAD.md
+recursive-include examples *
+recursive-exclude examples *.pyc
+recursive-exclude examples __pycache__
+recursive-exclude examples/shop_env *
+recursive-exclude examples/shop/media *
+recursive-exclude examples/shop/static/img *
+recursive-exclude examples/shop/db.sqlite3
+recursive-exclude tests *.pyc
+recursive-exclude tests __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * __pycache__
+recursive-exclude * *.so
+recursive-exclude * .DS_Store

paytechuz-0.1.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: paytechuz
+Version: 0.1.0
+Summary: Unified Python package for Uzbekistan payment gateways (Payme, Click)
+Home-page: https://github.com/Muhammadali-Akbarov/paytechuz
+Author: Muhammadali Akbarov
+Author-email: muhammadali17abc@gmail.com
+License: MIT
+Keywords: paytechuz,payme,click,uzbekistan,payment,gateway,payment-gateway,payment-processing,django,flask,fastapi
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: requests<3.0,>=2.0
+Requires-Dist: dataclasses<1.0,>=0.6; python_version < "3.7"
+Provides-Extra: django
+Requires-Dist: django<5.0,>=3.0; extra == "django"
+Requires-Dist: djangorestframework<4.0,>=3.0; extra == "django"
+Provides-Extra: fastapi
+Requires-Dist: fastapi<1.0.0,>=0.68.0; extra == "fastapi"
+Requires-Dist: sqlalchemy<3.0,>=1.4; extra == "fastapi"
+Requires-Dist: httpx<1.0,>=0.20; extra == "fastapi"
+Requires-Dist: python-multipart==0.0.20; extra == "fastapi"
+Requires-Dist: pydantic<2.0,>=1.8; extra == "fastapi"
+Provides-Extra: flask
+Requires-Dist: flask<3.0,>=2.0; extra == "flask"
+Requires-Dist: flask-sqlalchemy<3.0,>=2.5; extra == "flask"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# paytechuz
+
+paytechuz is a unified payment library for integration with popular payment systems in Uzbekistan (Payme and Click).
+
+[![PyPI version](https://badge.fury.io/py/paytechuz.svg)](https://badge.fury.io/py/paytechuz)
+[![Python Versions](https://img.shields.io/pypi/pyversions/paytechuz.svg)](https://pypi.org/project/paytechuz/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installation
+
+To install paytechuz with all dependencies:
+
+```bash
+pip install paytechuz
+```
+
+For specific framework support:
+
+```bash
+# For Django
+pip install paytechuz[django]
+
+# For FastAPI
+pip install paytechuz[fastapi]
+```
+
+## Quick Start
+
+### Django Integration
+
+1. Add the app to your `INSTALLED_APPS`:
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    # ...
+    'paytechuz.integrations.django',
+]
+
+# Payme settings
+PAYME_ID = 'your_payme_merchant_id'
+PAYME_KEY = 'your_payme_merchant_key'
+PAYME_ACCOUNT_MODEL = 'your_app.YourModel'  # For example: 'orders.Order'
+PAYME_ACCOUNT_FIELD = 'id'  # Field for account identifier
+PAYME_AMOUNT_FIELD = 'amount'  # Field for storing payment amount
+PAYME_ONE_TIME_PAYMENT = True  # Allow only one payment per account
+```
+
+2. Set up the webhook URLs:
+
+```python
+# urls.py
+from django.urls import path
+from django.views.decorators.csrf import csrf_exempt
+
+from your_app.views import PaymeWebhookView, ClickWebhookView
+
+
+urlpatterns = [
+    # ...
+    path('payments/payme/', csrf_exempt(PaymeWebhookView.as_view()), name='payme_webhook'),
+    path('payments/click/', csrf_exempt(ClickWebhookView.as_view()), name='click_webhook'),
+]
+```
+
+3. Create custom webhook handlers:
+
+```python
+# views.py
+from paytechuz.integrations.django.views import PaymeWebhookView as BasePaymeWebhookView
+from .models import Order
+
+class PaymeWebhookView(BasePaymeWebhookView):
+    def successfully_payment(self, params, transaction):
+        """Called when payment is successful"""
+        order_id = transaction.account_id
+        order = Order.objects.get(id=order_id)
+        order.status = 'paid'
+        order.save()
+        
+    def cancelled_payment(self, params, transaction):
+        """Called when payment is cancelled"""
+        order_id = transaction.account_id
+        order = Order.objects.get(id=order_id)
+        order.status = 'cancelled'
+        order.save()
+```
+
+### FastAPI Integration
+
+1. Create a custom webhook handler:
+
+```python
+from fastapi import APIRouter, Depends, Request
+from sqlalchemy.orm import Session
+
+from app.database.db import get_db
+from app.models.models import Order
+from paytechuz.integrations.fastapi import PaymeWebhookHandler
+
+# Payme configuration
+PAYME_ID = 'your_payme_id'
+PAYME_KEY = 'your_payme_key'
+
+class CustomPaymeWebhookHandler(PaymeWebhookHandler):
+    def successfully_payment(self, params, transaction) -> None:
+        """Called when payment is successful"""
+        order = self.db.query(Order).filter(Order.id == transaction.account_id).first()
+        if order:
+            order.status = "paid"
+            self.db.commit()
+
+    def cancelled_payment(self, params, transaction) -> None:
+        """Called when payment is cancelled"""
+        order = self.db.query(Order).filter(Order.id == transaction.account_id).first()
+        if order:
+            order.status = "cancelled"
+            self.db.commit()
+```
+
+2. Create a webhook endpoint:
+
+```python
+router = APIRouter()
+
+@router.post("/payments/payme/webhook")
+async def payme_webhook(request: Request, db: Session = Depends(get_db)):
+    """Handle Payme webhook requests"""
+    handler = CustomPaymeWebhookHandler(
+        db=db,
+        payme_id=PAYME_ID,
+        payme_key=PAYME_KEY,
+        account_model=Order,
+        account_field="id",
+        amount_field="amount",
+        one_time_payment=False
+    )
+    result = await handler.handle_webhook(request)
+    return result
+```
+
+## Documentation
+
+For detailed documentation, see:
+
+- [English Documentation](paytechuz/docs/en/index.md)
+- [O'zbek tilidagi hujjatlar](paytechuz/docs/index.md)

paytechuz-0.1.0/README.md

@@ -0,0 +1,147 @@
+# paytechuz
+
+paytechuz is a unified payment library for integration with popular payment systems in Uzbekistan (Payme and Click).
+
+[![PyPI version](https://badge.fury.io/py/paytechuz.svg)](https://badge.fury.io/py/paytechuz)
+[![Python Versions](https://img.shields.io/pypi/pyversions/paytechuz.svg)](https://pypi.org/project/paytechuz/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installation
+
+To install paytechuz with all dependencies:
+
+```bash
+pip install paytechuz
+```
+
+For specific framework support:
+
+```bash
+# For Django
+pip install paytechuz[django]
+
+# For FastAPI
+pip install paytechuz[fastapi]
+```
+
+## Quick Start
+
+### Django Integration
+
+1. Add the app to your `INSTALLED_APPS`:
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    # ...
+    'paytechuz.integrations.django',
+]
+
+# Payme settings
+PAYME_ID = 'your_payme_merchant_id'
+PAYME_KEY = 'your_payme_merchant_key'
+PAYME_ACCOUNT_MODEL = 'your_app.YourModel'  # For example: 'orders.Order'
+PAYME_ACCOUNT_FIELD = 'id'  # Field for account identifier
+PAYME_AMOUNT_FIELD = 'amount'  # Field for storing payment amount
+PAYME_ONE_TIME_PAYMENT = True  # Allow only one payment per account
+```
+
+2. Set up the webhook URLs:
+
+```python
+# urls.py
+from django.urls import path
+from django.views.decorators.csrf import csrf_exempt
+
+from your_app.views import PaymeWebhookView, ClickWebhookView
+
+
+urlpatterns = [
+    # ...
+    path('payments/payme/', csrf_exempt(PaymeWebhookView.as_view()), name='payme_webhook'),
+    path('payments/click/', csrf_exempt(ClickWebhookView.as_view()), name='click_webhook'),
+]
+```
+
+3. Create custom webhook handlers:
+
+```python
+# views.py
+from paytechuz.integrations.django.views import PaymeWebhookView as BasePaymeWebhookView
+from .models import Order
+
+class PaymeWebhookView(BasePaymeWebhookView):
+    def successfully_payment(self, params, transaction):
+        """Called when payment is successful"""
+        order_id = transaction.account_id
+        order = Order.objects.get(id=order_id)
+        order.status = 'paid'
+        order.save()
+        
+    def cancelled_payment(self, params, transaction):
+        """Called when payment is cancelled"""
+        order_id = transaction.account_id
+        order = Order.objects.get(id=order_id)
+        order.status = 'cancelled'
+        order.save()
+```
+
+### FastAPI Integration
+
+1. Create a custom webhook handler:
+
+```python
+from fastapi import APIRouter, Depends, Request
+from sqlalchemy.orm import Session
+
+from app.database.db import get_db
+from app.models.models import Order
+from paytechuz.integrations.fastapi import PaymeWebhookHandler
+
+# Payme configuration
+PAYME_ID = 'your_payme_id'
+PAYME_KEY = 'your_payme_key'
+
+class CustomPaymeWebhookHandler(PaymeWebhookHandler):
+    def successfully_payment(self, params, transaction) -> None:
+        """Called when payment is successful"""
+        order = self.db.query(Order).filter(Order.id == transaction.account_id).first()
+        if order:
+            order.status = "paid"
+            self.db.commit()
+
+    def cancelled_payment(self, params, transaction) -> None:
+        """Called when payment is cancelled"""
+        order = self.db.query(Order).filter(Order.id == transaction.account_id).first()
+        if order:
+            order.status = "cancelled"
+            self.db.commit()
+```
+
+2. Create a webhook endpoint:
+
+```python
+router = APIRouter()
+
+@router.post("/payments/payme/webhook")
+async def payme_webhook(request: Request, db: Session = Depends(get_db)):
+    """Handle Payme webhook requests"""
+    handler = CustomPaymeWebhookHandler(
+        db=db,
+        payme_id=PAYME_ID,
+        payme_key=PAYME_KEY,
+        account_model=Order,
+        account_field="id",
+        amount_field="amount",
+        one_time_payment=False
+    )
+    result = await handler.handle_webhook(request)
+    return result
+```
+
+## Documentation
+
+For detailed documentation, see:
+
+- [English Documentation](paytechuz/docs/en/index.md)
+- [O'zbek tilidagi hujjatlar](paytechuz/docs/index.md)

paytechuz-0.1.0/core/base.py

@@ -0,0 +1,88 @@
+"""
+Base classes for payment gateways.
+"""
+from abc import ABC, abstractmethod
+from typing import Dict, Any, Optional, Union
+
+class BasePaymentGateway(ABC):
+    """
+    Base class for all payment gateways.
+
+    This abstract class defines the common interface that all payment gateways
+    must implement. It provides a consistent API for creating, checking, and
+    canceling payments regardless of the underlying payment provider.
+    """
+
+    def __init__(self, is_test_mode: bool = False):
+        """
+        Initialize the payment gateway.
+
+        Args:
+            is_test_mode (bool): Whether to use the test environment
+        """
+        self.is_test_mode = is_test_mode
+
+    @abstractmethod
+    def create_payment(self, amount: Union[int, float, str], account_id: Union[int, str], **kwargs) -> Dict[str, Any]:
+        """
+        Create a payment.
+
+        Args:
+            amount: The payment amount
+            account_id: The account ID or order ID
+            **kwargs: Additional parameters specific to the payment gateway
+
+        Returns:
+            Dict containing payment details including transaction ID
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def check_payment(self, transaction_id: str) -> Dict[str, Any]:
+        """
+        Check payment status.
+
+        Args:
+            transaction_id: The transaction ID to check
+
+        Returns:
+            Dict containing payment status and details
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def cancel_payment(self, transaction_id: str, reason: Optional[str] = None) -> Dict[str, Any]:
+        """
+        Cancel payment.
+
+        Args:
+            transaction_id: The transaction ID to cancel
+            reason: Optional reason for cancellation
+
+        Returns:
+            Dict containing cancellation status and details
+        """
+        raise NotImplementedError
+
+
+
+class BaseWebhookHandler(ABC):
+    """
+    Base class for payment gateway webhook handlers.
+
+    This abstract class defines the common interface for handling webhook
+    callbacks from payment gateways.
+    """
+
+    @abstractmethod
+    def handle_webhook(self, data: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Handle webhook data from payment gateway.
+
+        Args:
+            data: The webhook data received from the payment gateway
+
+        Returns:
+            Dict containing the response to be sent back to the payment gateway
+        """
+        raise NotImplementedError

paytechuz-0.1.0/core/constants.py

@@ -0,0 +1,68 @@
+"""
+Constants for payment gateways.
+"""
+from enum import Enum
+
+class TransactionState(Enum):
+    """Transaction states."""
+    CREATED = 0
+    INITIATING = 1
+    SUCCESSFULLY = 2
+    CANCELED = -2
+    CANCELED_DURING_INIT = -1
+
+
+class PaymentGateway(Enum):
+    """Payment gateway types."""
+    PAYME = "payme"
+    CLICK = "click"
+
+class PaymeEndpoints:
+    """Payme API endpoints."""
+    RECEIPTS_CREATE = "receipts/create"
+    RECEIPTS_PAY = "receipts/pay"
+    RECEIPTS_SEND = "receipts/send"
+    RECEIPTS_CHECK = "receipts/check"
+    RECEIPTS_CANCEL = "receipts/cancel"
+    RECEIPTS_GET = "receipts/get"
+    CARDS_CREATE = "cards/create"
+    CARDS_VERIFY = "cards/verify"
+    CARDS_CHECK = "cards/check"
+    CARDS_REMOVE = "cards/remove"
+    CARDS_GET_VERIFY_CODE = "cards/get_verify_code"
+
+
+class PaymeNetworks:
+    """Payme API networks."""
+    TEST_NET = "https://checkout.test.paycom.uz/api"
+    PROD_NET = "https://checkout.paycom.uz/api"
+
+class ClickEndpoints:
+    """Click API endpoints."""
+    PREPARE = "prepare"
+    COMPLETE = "complete"
+    MERCHANT_API = "merchant/api"
+
+
+class ClickNetworks:
+    """Click API networks."""
+    TEST_NET = "https://api.click.uz/v2/merchant"
+    PROD_NET = "https://api.click.uz/v2/merchant"
+
+class ClickActions:
+    """Click API actions."""
+    PREPARE = 0
+    COMPLETE = 1
+
+
+class PaymeCancelReason:
+    """Payme cancel reason codes."""
+    REASON_USER_NOT_FOUND = 1
+    REASON_DEBIT_OPERATION_FAILED = 2
+    REASON_EXECUTION_ERROR = 3
+    REASON_TIMEOUT = 4
+    REASON_FUND_RETURNED = 5
+    REASON_UNKNOWN = 6
+    REASON_CANCELLED_BY_USER = 7
+    REASON_SUSPICIOUS_OPERATION = 8
+    REASON_MERCHANT_DECISION = 9