Metadata-Version: 2.1
Name: qpay-python
Version: 0.0.2
Summary: QPay v2 SDK client for Python projects
Home-page: https://github.com/khasbilegt/qpay-python
License: MIT
Keywords: python,qpay,sdk,payment,qr,finance
Author: khasbilegt
Author-email: khasbilegt.ts@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Framework :: Pydantic
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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: Topic :: Software Development :: Build Tools
Classifier: Typing :: Typed
Requires-Dist: pydantic (>=2.7.0,<3.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Project-URL: Repository, https://github.com/khasbilegt/qpay-python
Description-Content-Type: text/markdown

<h1 align="center">
  QPay Python
</h1>

<p align="center">
  <a href="https://github.com/khasbilegt/qpay-python/">
    <img src="https://img.shields.io/github/actions/workflow/status/khasbilegt/qpay-python/qa.yml?label=CI&logo=github&style=for-the-badge" alt="ci status">
  </a>
  <a href="https://codecov.io/github/khasbilegt/qpay-python">
    <img src="https://img.shields.io/codecov/c/github/khasbilegt/qpay-python?logo=codecov&style=for-the-badge" alt="codecov">
  </a>
  <br>
  <a href="https://pypi.org/project/qpay-python/">
    <img src="https://img.shields.io/pypi/v/qpay-python?style=for-the-badge" alt="pypi link">
  </a>
  <a>
    <img src="https://img.shields.io/pypi/pyversions/qpay-python?logo=python&style=for-the-badge" alt="supported python versions">
  </a>
</p>

<p align="center">
  <a href="#usage">Ашиглах</a> •
  <a href="#contribution">Хөгжүүлэлтэнд оролцох</a> •
  <a href="#license">Лиценз</a>
</p>

<p align="center">QPay v2 гүйлгээний сервисүүдийг Python хэлний орчинд ашиглахад зориулсан сан</p>

### <a id="usage"></a>QPayClient -г ашиглах

Хамгийн эхлээд `QPayClient` -с объект үүсгэж авна. Ингэхийн тулд KKTТ ХХК -тай гэрээ хийн нэр, нууц үг авсан байх шаардлагатай. Нэг л удаа үүсгээд авчихсан байхад токен дуусах, сунгах зэрэг дээр санаа зовох шаардлагагүй.

```py
import qpay import QPayClient

client = QPayClient(host="https://merchant.qpay.mn/v2/", username="MERCHANT_USERNAME", password="MERCHANT_PASSWORD")

...
```

QPayClient нь singleton paradigm -г ашигладаг учир нэг л объект үүсгэж, тэрийгээ дахин ашиглана. Шаардлагатай сервисүүдийг үүсгэсэн объектоороо дамжуулан дуудна.

```py
...

payload = {"invoice_code": ... }
invoice = client.invoice_create(json=payload)
print(invoice.qr_text) # 0002010102121531279404962794049600000000KKTQ...

...
```

## <a id="contribution"></a>Хөгжүүлэлтэнд оролцох

Энэхүү сантай холбоотой алдаа засвар, сайжруулалт болон бусад санал, хүсэлтийг нээлттэй хүлээж авах ба ялангуяа чанартай кодын өөрчлөлтүүд илгээвэл маш их баярлах болно.

Жич: Кодын өөрчлөлт оруулахдаа заавал тестийг нь хамт оруулахаа битгий мартаарай.

## <a id="license"></a>Лиценз

[MIT License](https://choosealicense.com/licenses/mit/)

