Skip to content
This repository has been archived by the owner on Oct 7, 2024. It is now read-only.

Commit

Permalink
Actions, Docs, Version Bump
Browse files Browse the repository at this point in the history
  • Loading branch information
mariofix committed Jul 10, 2023
1 parent db2fbc8 commit f3a65b1
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 37 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Release & Build Docs
name: New Release

on:
release:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/tests_coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Tests & Coverage

on:
push:
branches: [ "main", "dev" ]
branches: [ "main" ]
pull_request:
branches: [ "main", "dev" ]
branches: [ "main" ]

jobs:
tests:
Expand Down
2 changes: 1 addition & 1 deletion django_payments_flow/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
__version__ = "0.1.1"
__version__ = "0.1.2"

__all__ = ["__version__"]
2 changes: 1 addition & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# API

::: django_payments_khipu.KhipuProvider
::: django_payments_flow.KhipuProvider
24 changes: 12 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
# django-payments-khipu
# django-payments-flow

`Proyecto en desarrollo activo, no listo para produccion`

`django-payments-khipu` es una variante de Django Payments que implementa la
creación, confirmación y expiración de pagos realizados a través de Khipu. Este
módulo proporciona integración con la API de Khipu para facilitar el
`django-payments-flow` es una variante de Django Payments que implementa la
creación, confirmación y expiración de pagos realizados a través de Flow. Este
módulo proporciona integración con la API de Flow para facilitar el
procesamiento y gestión de pagos en tu aplicación web Django.


## Introducción

`django-payments-khipu` está diseñado para simplificar la integración de
pagos de Khipu en tu proyecto Django Payments. Con este módulo, puedes crear y
gestionar pagos utilizando la pasarela de pago de Khipu de manera sencilla.
`django-payments-flow` está diseñado para simplificar la integración de
pagos de Flow en tu proyecto Django Payments. Con este módulo, puedes crear y
gestionar pagos utilizando la pasarela de pago de Flow de manera sencilla.

Características principales:

- Crea y procesa pagos de forma segura con Khipu.
- Crea y procesa pagos de forma segura con Flow.
- Recibe notificaciones de confirmación de pago.
- Maneja automáticamente la expiración y cancelación de pagos.

## Instalación

Puedes instalar django-payments-khipu con:
Puedes instalar django-payments-flow con:

=== "usando pip"
```shell
pip install django-payments-khipu
pip install django-payments-flow
```
=== "usando poetry"
```shell
poetry add django-payments-khipu
poetry add django-payments-flow
```

## Configuración
Expand All @@ -39,7 +39,7 @@ La configuracion se realiza como una variante de Django Payments

```python
PAYMENT_VARIANTS = {
"khipu": ("django_payments_khipu.KhipuProvider", {
"flow": ("django_payments_flow.KhipuProvider", {
"key": 1,
"secret": "qwertyasdf0123456789",
})
Expand Down
25 changes: 7 additions & 18 deletions docs/uso.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@

## Instalación

Para utilizar el módulo `django-payments-khipu`, puedes realizar la instalación mediante el uso de pip o poetry.
Para utilizar el módulo `django-payments-flow`, puedes realizar la instalación mediante el uso de pip o poetry.

=== "usando pip"
```shell
pip install django-payments-khipu
pip install django-payments-flow
```
=== "usando poetry"
```shell
poetry add django-payments-khipu
poetry add django-payments-flow
```

## Configuración

La configuración del módulo django-payments-khipu se realiza como una variante
La configuración del módulo django-payments-flow se realiza como una variante
de Django Payments. Debes agregar la siguiente configuración en tu archivo de
configuración de Django:

```python
PAYMENT_VARIANTS = {
"khipu": ("django_payments_khipu.KhipuProvider", {
"flow": ("django_payments_flow.KhipuProvider", {
"receiver_id": 1,
"secret": "qwertyasdf0123456789",
})
Expand All @@ -34,20 +34,10 @@ PAYMENT_VARIANTS = {
identificar al receptor de los pagos.
* `secret`: Este valor corresponde a la contraseña entregada por Khipu para
autenticar la comunicación con su plataforma.
* `use_notificacion`: Puedes establecer este valor como `None` si deseas
deshabilitar las notificaciones de estado. Si deseas utilizar las
notificaciones, debes especificar la versión de la API de notificaciones de
Khipu en el formato "x.y" (Valor por defecto: 1.3).
* `bank_id`: Si necesitas utilizar variantes diferentes para cada cuenta
bancaria, puedes especificar el `bank_id` en esta configuración. También puedes
proporcionar este valor utilizando `datos_extra` en cada pago. Si no se define
este valor o se establece como None, Khipu solicitará el banco al que se
realizará la transferencia al momento de efectuar el pago
(Valor por defecto: `None`).

## Datos Extra

El módulo `django-payments-khipu` permite enviar datos extra en cada pago. Para
El módulo `django-payments-flow` permite enviar datos extra en cada pago. Para
hacerlo, debes utilizar un objeto JSON dentro de la propiedad "attrs" del
modelo de Pagos.

Expand All @@ -64,6 +54,5 @@ payment.save()
Puedes proporcionar un diccionario unidimensional con los valores extra que
deseas enviar en cada pago.

Cabe destacar que los valores `payer_email`, `subject`, `currency`, `amount`,
`transaction_id`, `notify_url`, y `notify_api_version` no pueden ser utilizados
Cabe destacar que los valores `payer_email`no pueden ser utilizados
como datos extra y serán ignorados al momento de crear el pago.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "django-payments-flow"
version = "0.1.1"
version = "0.1.2"
description = "Soporte Flow para Django Payments"
authors = ["Mario Hernandez <mariofix@proton.me>"]
license = "MIT"
Expand Down
2 changes: 1 addition & 1 deletion tests/test_app.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@


def test_version():
assert __version__ == "0.1.1"
assert __version__ == "0.1.2"

0 comments on commit f3a65b1

Please sign in to comment.