payme-pkg 3.0.6__tar.gz → 3.0.8__tar.gz

payme_pkg-3.0.8/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.1
+Name: payme-pkg
+Version: 3.0.8
+Home-page: https://github.com/Muhammadali-Akbarov/payme-pkg
+Author: Muhammadali Akbarov
+Author-email: muhammadali17abc@gmail.com
+License: MIT
+Keywords: paymeuz paycomuz payme-merchant merchant-api subscribe-api payme-pkg payme-api
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: requests==2.*
+Requires-Dist: dataclasses==0.*; python_version < "3.7"
+Requires-Dist: djangorestframework==3.*
+
+<h1 align="center">Payme PKG</h1>
+
+
+<p align="center">
+  <a href="https://docs.pay-tech.uz"><img src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"></a>
+  <a href="https://github.com/PayTechUz/payme-pkg"><img src="https://img.shields.io/badge/Open_Source-❤️-FDA599?"/></a>
+  <a href="t.me/+DK7n7lKx8GY5ZDZi"><img src="https://img.shields.io/badge/Community-Join%20Us-blueviolet"/></a>
+  <a href="https://github.com/PayTechUz/payme-pkg/issues"><img src="https://img.shields.io/github/issues/gitbookIO/gitbook"/></a>
+</p>
+
+<p align="center">Welcome to payme-pkg, the open source payme sdk for python.</p>
+
+<p align="center">You can use for test and production mode. Join our community and ask everything you need.
+</p>
+<a href="https://docs.pay-tech.uz">
+<p align="center">Visit to full documentation for Merchant and Subcribe Api</p>
+</a>
+<p align="center">
+ <img style="width: 60%;" src="https://i.postimg.cc/WbD32bHC/payme-pkg-demo-m4a.gif">
+</p>
+
+## Installation
+
+```shell
+pip install payme-pkg
+```
+
+## Installation to Django
+
+Add `'payme'` in to your settings.py
+
+```python
+INSTALLED_APPS = [
+    ...
+    'payme',
+    ...
+]
+```
+
+Add `'payme'` credentials inside to settings.py
+
+One time payment (Однаразовый платеж) configuration settings.py
+
+Example project: https://github.com/PayTechUz/shop-backend
+```python
+PAYME_ID = "your-payme-id"
+PAYME_KEY = "your-payme-key"
+PAYME_ACCOUNT_FIELD = "order_id"
+PAYME_AMOUNT_FIELD = "total_amount"
+PAYME_ACCOUNT_MODEL = "orders.models.Orders"
+PAYME_ONE_TIME_PAYMENT = True
+```
+
+Multi payment (Накопительный) configuration settings.py
+
+Example project: Coming soon
+```python
+PAYME_ID = "your-payme-id"
+PAYME_KEY = "your-payme-key"
+PAYME_ACCOUNT_FIELD = "id"
+PAYME_ACCOUNT_MODEL = "clients.models.Client"
+PAYME_ONE_TIME_PAYMENT = False
+```
+
+Create a new View that about handling call backs
+```python
+from payme.views import PaymeWebHookAPIView
+
+
+class PaymeCallBackAPIView(PaymeWebHookAPIView):
+    def handle_created_payment(self, params, result, *args, **kwargs):
+        """
+        Handle the successful payment. You can override this method
+        """
+        print(f"Transaction created for this params: {params} and cr_result: {result}")
+
+    def handle_successfully_payment(self, params, result, *args, **kwargs):
+        """
+        Handle the successful payment. You can override this method
+        """
+        print(f"Transaction successfully performed for this params: {params} and performed_result: {result}")
+
+    def handle_cancelled_payment(self, params, result, *args, **kwargs):
+        """
+        Handle the cancelled payment. You can override this method
+        """
+        print(f"Transaction cancelled for this params: {params} and cancelled_result: {result}")
+```
+
+Add a `payme` path to core of urlpatterns:
+
+```python
+from django.urls import path
+from django.urls import include
+
+from your_app.views import PaymeCallBackAPIView
+
+urlpatterns = [
+    ...
+    path("payment/update/", PaymeCallBackAPIView.as_view()),
+    ...
+]
+```
+
+Run migrations
+```shell
+python3 manage.py makemigrations && python manage.py migrate
+```
+🎉 Congratulations you have been integrated merchant api methods with django, keep reading docs. After successfull migrations check your admin panel and see results what happened.
+
+## Generate Pay Link
+
+Example to generate link:
+
+- Input
+
+```python
+from payme import Payme
+
+payme = Payme(payme_id="your-payme-id")
+pay_link = payme.initializer.generate_pay_link(id=123456, amount=5000, return_url="https://example.com")
+print(pay_link)
+```
+
+- Output
+
+```
+https://checkout.paycom.uz/bT15b3VyLXBheW1lLWlkO2FjLmlkPTEyMzQ1NjthPTUwMDAwMDtjPWh0dHBzOi8vZXhhbXBsZS5jb20=
+```

{payme_pkg-3.0.6 → payme_pkg-3.0.8}/README.md

@@ -39,17 +39,21 @@ INSTALLED_APPS = [
 
 Add `'payme'` credentials inside to settings.py
 
-One time payment configuration settings.py
+One time payment (Однаразовый платеж) configuration settings.py
+
+Example project: https://github.com/PayTechUz/shop-backend
 ```python
 PAYME_ID = "your-payme-id"
 PAYME_KEY = "your-payme-key"
-PAYME_ACCOUNT_FIELD = "id"
+PAYME_ACCOUNT_FIELD = "order_id"
 PAYME_AMOUNT_FIELD = "total_amount"
 PAYME_ACCOUNT_MODEL = "orders.models.Orders"
 PAYME_ONE_TIME_PAYMENT = True
 ```
 
-Multi payment configuration settings.py
+Multi payment (Накопительный) configuration settings.py
+
+Example project: Coming soon
 ```python
 PAYME_ID = "your-payme-id"
 PAYME_KEY = "your-payme-key"

{payme_pkg-3.0.6 → payme_pkg-3.0.8}/payme/classes/cards.py

@@ -1,6 +1,5 @@
 from typing import Optional
 
-from payme.util import input_type_checker
 from payme.classes.http import HttpClient
 from payme.types.response import cards as response
 
@@ -20,8 +19,6 @@ class Cards:
     services. It allows you to create new cards and retrieve verification
     codes for existing cards.
     """
-
-    @input_type_checker
     def __init__(self, url: str, payme_id: str) -> "Cards":
         """
         Initialize the Cards client.
@@ -35,7 +32,6 @@ class Cards:
         }
         self.http = HttpClient(url, headers)
 
-    @input_type_checker
     def create(self, number: str, expire: str, save: bool = False,
                timeout: int = 10) -> response.CardsCreateResponse:
         """
@@ -53,7 +49,6 @@ class Cards:
         params = {"card": {"number": number, "expire": expire}, "save": save}
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def get_verify_code(self, token: str, timeout: int = 10) -> \
             response.GetVerifyResponse:
         """
@@ -68,7 +63,6 @@ class Cards:
         params = {"token": token}
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def verify(self, token: str, code: str, timeout: int = 10) -> \
             response.VerifyResponse:
         """
@@ -84,7 +78,6 @@ class Cards:
         params = {"token": token, "code": code}
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def remove(self, token: str, timeout: int = 10) -> response.RemoveResponse:
         """
         Remove a card from the Paycom system.
@@ -98,7 +91,6 @@ class Cards:
         params = {"token": token}
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def check(self, token: str, timeout: int = 10) -> response.CheckResponse:
         """
         Check the status of a card.
@@ -112,7 +104,6 @@ class Cards:
         params = {"token": token}
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def _post_request(self, method: str, params: dict,
                       timeout: int = 10) -> response.Common:
         """

{payme_pkg-3.0.6 → payme_pkg-3.0.8}/payme/classes/client.py

@@ -3,7 +3,6 @@ from typing import Union
 
 from payme.const import Networks
 from payme.classes.cards import Cards
-from payme.util import input_type_checker
 from payme.classes.receipts import Receipts
 from payme.classes.initializer import Initializer
 
@@ -12,7 +11,6 @@ class Payme:
     """
     The payme class provides a simple interface
     """
-    @input_type_checker
     def __init__(
         self,
         payme_id: str,
@@ -24,7 +22,7 @@ class Payme:
         url = Networks.PROD_NET
 
         if is_test_mode is True:
-            url = Networks.TEST_NET
+            url = Networks.TEST_NET.value
 
         self.cards = Cards(url=url, payme_id=payme_id)
         self.initializer = Initializer(payme_id=payme_id)

{payme_pkg-3.0.6 → payme_pkg-3.0.8}/payme/classes/initializer.py

@@ -2,8 +2,6 @@ import base64
 
 from django.conf import settings
 
-from payme.util import input_type_checker
-
 
 class Initializer:
     """
@@ -15,7 +13,6 @@ class Initializer:
         The Payme ID associated with your account
     """
 
-    @input_type_checker
     def __init__(self, payme_id: str = None):
         self.payme_id = payme_id
 
@@ -58,20 +55,3 @@ class Initializer:
         )
         params = base64.b64encode(params.encode("utf-8")).decode("utf-8")
         return f"https://checkout.paycom.uz/{params}"
-
-    def test(self):
-        """
-        Test method for the Initializer class.
-
-        This method generates a payment link for a sample order and checks
-        if the result is a valid string. If successful, it prints a
-        confirmation message.
-        """
-        result = self.generate_pay_link(
-            id=12345,
-            amount=7000,
-            return_url="https://example.com"
-        )
-
-        assert isinstance(result, str), "Failed to generate payment link"
-        print("Success: Payment link generated successfully.")

{payme_pkg-3.0.6 → payme_pkg-3.0.8}/payme/classes/receipts.py

@@ -1,7 +1,6 @@
 from typing import Union, Optional
 
 from payme.classes.cards import Cards
-from payme.util import input_type_checker
 from payme.classes.http import HttpClient
 from payme.types.response import receipts as response
 
@@ -37,7 +36,6 @@ class Receipts:
         }
         self.http = HttpClient(url, headers)
 
-    @input_type_checker
     def create(
         self,
         account: dict,
@@ -64,7 +62,6 @@ class Receipts:
         }
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def pay(
         self, receipts_id: str, token: str, timeout: int = 10
     ) -> response.PayResponse:
@@ -83,7 +80,6 @@ class Receipts:
         }
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def send(
         self, receipts_id: str, phone: str, timeout: int = 10
     ) -> response.SendResponse:
@@ -101,7 +97,6 @@ class Receipts:
         }
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def cancel(
         self, receipts_id: str, timeout: int = 10
     ) -> response.CancelResponse:
@@ -117,7 +112,6 @@ class Receipts:
         }
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def check(
         self, receipts_id: str, timeout: int = 10
     ) -> response.CheckResponse:
@@ -133,7 +127,6 @@ class Receipts:
         }
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def get(
         self, receipts_id: str, timeout: int = 10
     ) -> response.GetResponse:
@@ -149,7 +142,6 @@ class Receipts:
         }
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def get_all(
         self, count: int, from_: int, to: int, offset: int, timeout: int = 10
     ) -> response.GetAllResponse:
@@ -171,7 +163,6 @@ class Receipts:
         }
         return self._post_request(method, params, timeout)
 
-    @input_type_checker
     def _post_request(
         self, method: str, params: dict, timeout: int = 10
     ) -> response.Common:

payme_pkg-3.0.8/payme/const.py

@@ -0,0 +1,12 @@
+"""
+Payme enumerations
+"""
+from enum import Enum
+
+
+class Networks(str, Enum):
+    """
+    Payme networks
+    """
+    PROD_NET = "https://checkout.paycom.uz/api"
+    TEST_NET = "https://checkout.test.paycom.uz/api"

payme_pkg-3.0.8/payme/util.py

@@ -0,0 +1,26 @@
+from datetime import datetime
+
+
+def time_to_payme(datatime) -> int:
+    """
+    Convert datetime object to Payme's datetime format.
+
+    Payme's datetime format is in the format: YYYY-MM-DD HH:MM:SS.ssssss
+
+    Args:
+    datatime (datetime): The datetime object to convert.
+
+    Returns:
+    str: The datetime object in Payme's datetime format.
+    """
+    if not datatime:
+        return 0
+
+    return int(datatime.timestamp() * 1000)
+
+
+def time_to_service(milliseconds: int) -> datetime:
+    """
+    Converts milliseconds since the epoch to a datetime object.
+    """
+    return datetime.fromtimestamp(milliseconds / 1000)

payme_pkg-3.0.8/payme_pkg.egg-info/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.1
+Name: payme-pkg
+Version: 3.0.8
+Home-page: https://github.com/Muhammadali-Akbarov/payme-pkg
+Author: Muhammadali Akbarov
+Author-email: muhammadali17abc@gmail.com
+License: MIT
+Keywords: paymeuz paycomuz payme-merchant merchant-api subscribe-api payme-pkg payme-api
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: requests==2.*
+Requires-Dist: dataclasses==0.*; python_version < "3.7"
+Requires-Dist: djangorestframework==3.*
+
+<h1 align="center">Payme PKG</h1>
+
+
+<p align="center">
+  <a href="https://docs.pay-tech.uz"><img src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"></a>
+  <a href="https://github.com/PayTechUz/payme-pkg"><img src="https://img.shields.io/badge/Open_Source-❤️-FDA599?"/></a>
+  <a href="t.me/+DK7n7lKx8GY5ZDZi"><img src="https://img.shields.io/badge/Community-Join%20Us-blueviolet"/></a>
+  <a href="https://github.com/PayTechUz/payme-pkg/issues"><img src="https://img.shields.io/github/issues/gitbookIO/gitbook"/></a>
+</p>
+
+<p align="center">Welcome to payme-pkg, the open source payme sdk for python.</p>
+
+<p align="center">You can use for test and production mode. Join our community and ask everything you need.
+</p>
+<a href="https://docs.pay-tech.uz">
+<p align="center">Visit to full documentation for Merchant and Subcribe Api</p>
+</a>
+<p align="center">
+ <img style="width: 60%;" src="https://i.postimg.cc/WbD32bHC/payme-pkg-demo-m4a.gif">
+</p>
+
+## Installation
+
+```shell
+pip install payme-pkg
+```
+
+## Installation to Django
+
+Add `'payme'` in to your settings.py
+
+```python
+INSTALLED_APPS = [
+    ...
+    'payme',
+    ...
+]
+```
+
+Add `'payme'` credentials inside to settings.py
+
+One time payment (Однаразовый платеж) configuration settings.py
+
+Example project: https://github.com/PayTechUz/shop-backend
+```python
+PAYME_ID = "your-payme-id"
+PAYME_KEY = "your-payme-key"
+PAYME_ACCOUNT_FIELD = "order_id"
+PAYME_AMOUNT_FIELD = "total_amount"
+PAYME_ACCOUNT_MODEL = "orders.models.Orders"
+PAYME_ONE_TIME_PAYMENT = True
+```
+
+Multi payment (Накопительный) configuration settings.py
+
+Example project: Coming soon
+```python
+PAYME_ID = "your-payme-id"
+PAYME_KEY = "your-payme-key"
+PAYME_ACCOUNT_FIELD = "id"
+PAYME_ACCOUNT_MODEL = "clients.models.Client"
+PAYME_ONE_TIME_PAYMENT = False
+```
+
+Create a new View that about handling call backs
+```python
+from payme.views import PaymeWebHookAPIView
+
+
+class PaymeCallBackAPIView(PaymeWebHookAPIView):
+    def handle_created_payment(self, params, result, *args, **kwargs):
+        """
+        Handle the successful payment. You can override this method
+        """
+        print(f"Transaction created for this params: {params} and cr_result: {result}")
+
+    def handle_successfully_payment(self, params, result, *args, **kwargs):
+        """
+        Handle the successful payment. You can override this method
+        """
+        print(f"Transaction successfully performed for this params: {params} and performed_result: {result}")
+
+    def handle_cancelled_payment(self, params, result, *args, **kwargs):
+        """
+        Handle the cancelled payment. You can override this method
+        """
+        print(f"Transaction cancelled for this params: {params} and cancelled_result: {result}")
+```
+
+Add a `payme` path to core of urlpatterns:
+
+```python
+from django.urls import path
+from django.urls import include
+
+from your_app.views import PaymeCallBackAPIView
+
+urlpatterns = [
+    ...
+    path("payment/update/", PaymeCallBackAPIView.as_view()),
+    ...
+]
+```
+
+Run migrations
+```shell
+python3 manage.py makemigrations && python manage.py migrate
+```
+🎉 Congratulations you have been integrated merchant api methods with django, keep reading docs. After successfull migrations check your admin panel and see results what happened.
+
+## Generate Pay Link
+
+Example to generate link:
+
+- Input
+
+```python
+from payme import Payme
+
+payme = Payme(payme_id="your-payme-id")
+pay_link = payme.initializer.generate_pay_link(id=123456, amount=5000, return_url="https://example.com")
+print(pay_link)
+```
+
+- Output
+
+```
+https://checkout.paycom.uz/bT15b3VyLXBheW1lLWlkO2FjLmlkPTEyMzQ1NjthPTUwMDAwMDtjPWh0dHBzOi8vZXhhbXBsZS5jb20=
+```

{payme_pkg-3.0.6 → payme_pkg-3.0.8}/setup.py

@@ -1,9 +1,13 @@
+import pathlib
 from setuptools import setup, find_packages
 
+here = pathlib.Path(__file__).parent.resolve()
+
+long_description = (here / "README.md").read_text(encoding="utf-8")
 
 setup(
     name='payme-pkg',
-    version='3.0.6',
+    version='3.0.8',
     license='MIT',
     author="Muhammadali Akbarov",
     author_email='muhammadali17abc@gmail.com',
@@ -15,4 +19,6 @@ setup(
         "dataclasses==0.*;python_version<'3.7'",  # will only install on py3.6
         'djangorestframework==3.*'
       ],
+    long_description=long_description,
+    long_description_content_type="text/markdown",
 )

payme_pkg-3.0.6/PKG-INFO

@@ -1,12 +0,0 @@
-Metadata-Version: 2.1
-Name: payme-pkg
-Version: 3.0.6
-Home-page: https://github.com/Muhammadali-Akbarov/payme-pkg
-Author: Muhammadali Akbarov
-Author-email: muhammadali17abc@gmail.com
-License: MIT
-Keywords: paymeuz paycomuz payme-merchant merchant-api subscribe-api payme-pkg payme-api
-License-File: LICENSE.txt
-Requires-Dist: requests==2.*
-Requires-Dist: dataclasses==0.*; python_version < "3.7"
-Requires-Dist: djangorestframework==3.*

payme_pkg-3.0.6/payme/const.py

@@ -1,35 +0,0 @@
-"""
-Payme enumerations
-"""
-from enum import Enum
-
-
-class Methods(str, Enum):
-    """
-    The enumeration of create transaction methods.
-
-    Available Methods:
-    - GET_STATEMENT: Fetches transaction statement.
-    - CHECK_TRANSACTION: Checks a transaction.
-    - CREATE_TRANSACTION: Creates a new transaction.
-    - CANCEL_TRANSACTION: Cancels an existing transaction.
-    - PERFORM_TRANSACTION: Performs a transaction.
-    - CHECK_PERFORM_TRANSACTION: Checks if the transaction can be performed.
-    """
-    GET_STATEMENT = "GetStatement"
-    CHECK_TRANSACTION = "CheckTransaction"
-    CREATE_TRANSACTION = "CreateTransaction"
-    CANCEL_TRANSACTION = "CancelTransaction"
-    PERFORM_TRANSACTION = "PerformTransaction"
-    CHECK_PERFORM_TRANSACTION = "CheckPerformTransaction"
-
-    def __str__(self):
-        return str(self.value)
-
-
-class Networks(str, Enum):
-    """
-    Payme networks
-    """
-    PROD_NET = "https://checkout.paycom.uz/api"
-    TEST_NET = "https://checkout.test.paycom.uz/api"

payme_pkg-3.0.6/payme/util.py

@@ -1,53 +0,0 @@
-from functools import wraps
-from datetime import datetime
-from typing import get_type_hints
-
-
-def time_to_payme(datatime) -> int:
-    """
-    Convert datetime object to Payme's datetime format.
-
-    Payme's datetime format is in the format: YYYY-MM-DD HH:MM:SS.ssssss
-
-    Args:
-    datatime (datetime): The datetime object to convert.
-
-    Returns:
-    str: The datetime object in Payme's datetime format.
-    """
-    if not datatime:
-        return 0
-
-    return int(datatime.timestamp() * 1000)
-
-
-def time_to_service(milliseconds: int) -> datetime:
-    """
-    Converts milliseconds since the epoch to a datetime object.
-    """
-    return datetime.fromtimestamp(milliseconds / 1000)
-
-
-def input_type_checker(func):
-    """
-    input type checker decorator helps to
-    validate the input types of the function before executing it.
-    """
-    @wraps(func)
-    def wrapper(*args, **kwargs):
-        """
-        Get the type hints of the function
-        """
-        hints = get_type_hints(func)
-
-        all_args = kwargs.copy()
-        all_args.update(zip(func.__code__.co_varnames, args))
-
-        for arg_name, arg_type in hints.items():
-            if arg_name in all_args and not isinstance(all_args[arg_name], arg_type): # noqa
-                raise TypeError(
-                    f"Argument '{arg_name}' in {func.__name__} must be of type {arg_type.__name__}, "  # noqa
-                    f"but got {type(all_args[arg_name]).__name__}."
-                )
-        return func(*args, **kwargs)
-    return wrapper

payme_pkg-3.0.6/payme_pkg.egg-info/PKG-INFO

@@ -1,12 +0,0 @@
-Metadata-Version: 2.1
-Name: payme-pkg
-Version: 3.0.6
-Home-page: https://github.com/Muhammadali-Akbarov/payme-pkg
-Author: Muhammadali Akbarov
-Author-email: muhammadali17abc@gmail.com
-License: MIT
-Keywords: paymeuz paycomuz payme-merchant merchant-api subscribe-api payme-pkg payme-api
-License-File: LICENSE.txt
-Requires-Dist: requests==2.*
-Requires-Dist: dataclasses==0.*; python_version < "3.7"
-Requires-Dist: djangorestframework==3.*