diff --git a/README.md b/README.md index 6c78588..5321539 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # django-payments-chile -`django-payments-chile` es una extensión para `django-payments`, una biblioteca que proporciona una interfaz universal para procesar pagos en aplicaciones Django. Este proyecto añade soporte específico para varios proveedores de pagos chilenos como Flow, Khipu, Webpay, y otros. +`django-payments-chile` es una extensión para [django-payments](https://github.com/jazzband/django-payments), una biblioteca que proporciona una interfaz universal para procesar pagos en aplicaciones Django. Este proyecto añade soporte específico para varios proveedores de pagos chilenos como Flow, Khipu, Webpay, y otros. :warning: :warning: **Este proyecto está en desarrollo activo**, usar con precaución. :warning: :warning: @@ -36,14 +36,40 @@ ## Instalación -Para instalar la librería, utiliza pip: +La biblioteca `django-payments-chile` está disponible en PyPi. Puedes instalarla fácilmente con tu gestor de paquetes favorito, como `pip`, `poetry`, o `pipenv`. ```bash +pip install django-payments-chile +``` + +### Instalación de Extras + +Algunos proveedores requieren dependencias adicionales para funcionar correctamente. Puedes instalar estas dependencias mediante extras: + +```bash +# Instala todas las dependencias extra pip install django-payments-chile[todos] ``` -- **flow**: Instala extras para Flow. -- **todos**: Instala todos los extras. +Los extras disponibles son: + +- **webpay**: Incluye la dependencia `transbank-sdk`. +- **oneclick**: También incluye `transbank-sdk`. +- **todos**: Instala todas las dependencias extra mencionadas. + +Por ejemplo, para instalar solo las dependencias necesarias para Webpay, puedes ejecutar: + +```bash +pip install django-payments-chile[webpay] +``` + +Esto es equivalente a instalar las dependencias manualmente: + +```bash +pip install django-payments-chile transbank-sdk +``` + +**Nota**: La instalación de extras es opcional. Si prefieres, puedes gestionar las dependencias adicionales de forma manual en tu proyecto. ### Configuración de Proveedores @@ -64,4 +90,6 @@ PAYMENT_VARIANTS = { ## Licencia -Este proyecto está licenciado bajo la licencia [MIT](LICENSE). +Este proyecto no está afiliado, asociado ni patrocinado por ninguna de las empresas mencionadas en el listado de compatibilidad. + +El código de este proyecto está disponible bajo la licencia [MIT](LICENSE), lo que significa que puedes utilizarlo, modificarlo y distribuirlo de manera libre, sujeto a las condiciones establecidas en dicha licencia. diff --git a/pyproject.toml b/pyproject.toml index 38fdf63..e748c21 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,14 @@ +[build-system] +requires = ["setuptools >= 61.0"] +build-backend = "setuptools.build_meta" + [project] name = "django-payments-chile" version = "2024.12.2" description = "Pasarelas de pago chilenas para django-payments" readme = "README.md" authors = [{ "name" = "Mario Hernandez", "email" = "mariofix@proton.me" }] -license = { text = "MIT" } +license = { text = "MIT License" } requires-python = ">=3.9,<4.0" keywords = [ @@ -40,19 +44,15 @@ classifiers = [ dependencies = ["django-payments>=2.0, <4.0", "requests"] [project.urls] -homepage = "https://mariofix.github.io/django-payments-chile/" -repository = "https://github.com/mariofix/django-payments-chile" -documentation = "https://mariofix.github.io/django-payments-chile/" +Homepage = "https://mariofix.github.io/django-payments-chile/" +Repository = "https://github.com/mariofix/django-payments-chile" +Documentation = "https://mariofix.github.io/django-payments-chile/" [project.optional-dependencies] -flow = ["pyflowcl"] -khipu = ["pykhipu"] webpay = ["transbank-sdk>=5.0.0"] oneclick = ["transbank-sdk>=5.0.0"] -todos = ["pyflowcl", "pykhipu", "transbank-sdk>=5.0.0"] - -[dependency-groups] +todos = ["transbank-sdk>=5.0.0"] dev = [ "pre-commit", "black", @@ -77,12 +77,8 @@ dev = [ ] -[build-system] -requires = ["setuptools", "wheel"] -build-backend = "setuptools.build_meta" - [tool.setuptools.packages.find] -include = ["django_payments_chile", "tests"] +include = ["django_payments_chile", "tests", "ejemplo"] [tool.pytest.ini_options] # DJANGO_SETTINGS_MODULE = "tests.django_settings"