From f3a65b14afa1f6f7c5f6f64979889afe945fae1a Mon Sep 17 00:00:00 2001 From: Mario Hernandez Date: Mon, 10 Jul 2023 16:57:46 -0400 Subject: [PATCH] Actions, Docs, Version Bump --- .../{tests_release.yml => new_release.yml} | 2 +- .github/workflows/tests_coverage.yml | 4 +-- django_payments_flow/__init__.py | 2 +- docs/api.md | 2 +- docs/index.md | 24 +++++++++--------- docs/uso.md | 25 ++++++------------- pyproject.toml | 2 +- tests/test_app.py | 2 +- 8 files changed, 26 insertions(+), 37 deletions(-) rename .github/workflows/{tests_release.yml => new_release.yml} (98%) diff --git a/.github/workflows/tests_release.yml b/.github/workflows/new_release.yml similarity index 98% rename from .github/workflows/tests_release.yml rename to .github/workflows/new_release.yml index 3d498d1..3266423 100644 --- a/.github/workflows/tests_release.yml +++ b/.github/workflows/new_release.yml @@ -1,4 +1,4 @@ -name: Release & Build Docs +name: New Release on: release: diff --git a/.github/workflows/tests_coverage.yml b/.github/workflows/tests_coverage.yml index cfbb835..579cfb2 100644 --- a/.github/workflows/tests_coverage.yml +++ b/.github/workflows/tests_coverage.yml @@ -2,9 +2,9 @@ name: Tests & Coverage on: push: - branches: [ "main", "dev" ] + branches: [ "main" ] pull_request: - branches: [ "main", "dev" ] + branches: [ "main" ] jobs: tests: diff --git a/django_payments_flow/__init__.py b/django_payments_flow/__init__.py index 0dc5d6a..62757e3 100644 --- a/django_payments_flow/__init__.py +++ b/django_payments_flow/__init__.py @@ -1,3 +1,3 @@ -__version__ = "0.1.1" +__version__ = "0.1.2" __all__ = ["__version__"] diff --git a/docs/api.md b/docs/api.md index 8e06aab..0dadd5c 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,3 +1,3 @@ # API -::: django_payments_khipu.KhipuProvider +::: django_payments_flow.KhipuProvider diff --git a/docs/index.md b/docs/index.md index bf8aded..eac47db 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 @@ -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", }) diff --git a/docs/uso.md b/docs/uso.md index 9f50788..31773c7 100644 --- a/docs/uso.md +++ b/docs/uso.md @@ -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", }) @@ -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. @@ -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. diff --git a/pyproject.toml b/pyproject.toml index 2d17882..06ac046 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 "] license = "MIT" diff --git a/tests/test_app.py b/tests/test_app.py index d234ac4..03d741f 100644 --- a/tests/test_app.py +++ b/tests/test_app.py @@ -2,4 +2,4 @@ def test_version(): - assert __version__ == "0.1.1" + assert __version__ == "0.1.2"