Metadata-Version: 2.1
Name: Flask-SimplePay
Version: 1.2
Summary: OTP SimplePay payment extension for Flask
Home-page: https://github.com/gerelorant/Flask-SimplePay
Author: Gere Lóránt
Author-email: gerelorant@gmail.com
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

# Flask-SimplePay

OTP SimplePay integration with Flask

## Usage
Initialize the extension with Flask and Flask-SQLAlchemy instances.
```python
from flask import Flask
from flask_simplepay import SimplePay
from flask_sqlalchemy import SQLAlchemy


app = Flask(__name__)
db = SQLAlchemy(app)
simple = SimplePay(app, db)
    

if __name__ == '__main__':
    app.run()
```
To start payment, a `Transaction` is needed. After adding the transaction and 
commiting the session, the `/simple/start/<int:transaction_id>` endpoint starts
the payment procedure. When the payment process is finished, the `/simple/back`
endpoint is called. To define the behaviour upon the callback, extend the `TransactionMixin` 
class and override the `back()` method. Return value should be anything a Flask
route method would return.
```python
from flask import render_template
from flask_simplepay import TransactionMixin


class Transaction(db.Model, TransactionMixin):
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    
    def back(self):
        return render_template(self.result, transaction=self)
```
The `Transaction` model class should be provided at initialization as
`transaction_class` argument.


