Python SDK for the QvaPay API
Non official, but friendly QvaPay library for the Python language.
Setup
You can install this package by using the pip tool and installing:
pip install qvapay
Or
easy_install qvapay
Sign up on QvaPay
Create your account to process payments through QvaPay at qvapay.com/register.
Using the client
First, import the AsyncQvaPayClient (or SyncQvaPayClient) class and create your QvaPay asynchronous (or synchronous) client using your app credentials.
from qvapay.v1 import AsyncQvaPayClient
client = AsyncQvaPayClient(app_id, app_secret)
It is also possible to use the QvaPayAuth class (which by default obtains its properties from environment variables or from the content of the .env file) and the static method AsyncQvaPayClient.from_auth (or SyncQvaPayClient.from_auth) to initialize the client.
from qvapay.v1 import AsyncQvaPayClient, QvaPayAuth
client = AsyncQvaPayClient.from_auth(QvaPayAuth())
Use context manager
The recommended way to use a client is as a context manager. For example:
async with AsyncQvaPayClient(...) as client:
# Do anything you want
...
or
with SyncQvaPayClient(...) as client:
# Do anything you want
...
Get your app info
# Use await when using AsyncQvaPayClient
# With SyncQvaPayClient it is not necessary.
info = await client.get_info()
Get your account balance
# Use await when using AsyncQvaPayClient
# With SyncQvaPayClient it is not necessary.
balance = await client.get_balance()
Create an invoice
# Use await when using AsyncQvaPayClient
# With SyncQvaPayClient it is not necessary.
transaction = await client.create_invoice(
amount=10,
description='Ebook',
remote_id='EE-BOOk-123' # example remote invoice id
)
Get transaction
# Use await when using AsyncQvaPayClient
# With SyncQvaPayClient it is not necessary.
transaction = await client.get_transaction(id)
Get transactions
# Use await when using AsyncQvaPayClient
# With SyncQvaPayClient it is not necessary.
transactions = await client.get_transactions(page=1)
You can also read the QvaPay API documentation: qvapay.com/docs.
For developers
The _sync folders were generated automatically executing the command unasync qvapay tests.
The code that is added in the _async folders is automatically transformed.
So every time to make a change you must run the command unasync qvapay tests to regenerate the folders _sync with the synchronous version of the implementation.
Improve tests implementation and add pre-commit system to ensure format and style.
Migration guide
0.2.0 -> 0.3.0
QvaPayClientwas divided into two classes:AsyncQvaPayClientandSyncQvaPayClient. Both classes have the same methods and properties, with the difference that the methods inAsyncQvaPayClientare asynchronous and inSyncQvaPayClientare synchronous.
0.1.0 -> 0.2.0
user_idofTransactionmodel was removedpaid_by_user_idofTransactionmodel was removed
0.0.3 -> 0.1.0
from qvapay.v1 import *instead offrom qvapay import *QvaPayClientinstead ofClientclient.get_infoinstead ofclient.infoclient.get_balanceinstead ofclient.balanceclient.get_transactionsinstead ofclient.transactions
Contributors
✨
Thanks goes to these wonderful people (emoji key):
 Carlos Lugones |
 Ozkar L. Garcell |
 Leynier Gutiérrez González |
 Jorge Alejandro Jimenez Luna |
 Reinier Hernández |
This project follows the all-contributors specification. Contributions of any kind welcome!
4 Dec 21, 2021
2 Jan 19, 2022
4 Aug 06, 2022
3.2k Jan 02, 2023
1 Aug 30, 2022
8 Dec 04, 2022
1 Jan 31, 2022
93 Dec 27, 2022
5 Apr 05, 2022
43 Dec 12, 2022
6 May 31, 2022
59 Dec 04, 2022
3 Dec 14, 2022
57 Nov 07, 2022
4 Apr 24, 2022
6 Nov 22, 2022
16 Sep 24, 2022
3 May 16, 2022
14 Dec 15, 2022
4 Oct 26, 2021