transbank-sdk

Transbank Python SDK


Keywords
hacktoberfest
Licenses
BSD-3-Clause/Zed
Install
pip install transbank-sdk==1.4.0

Documentation

Build Status Quality Gate PyPI version

Transbank Python SDK

SDK Oficial de Transbank

Requisitos:

  • Python 3.4+

Instalaci贸n

Puedes instalar el SDK directamente

pip install transbank-sdk

O puedes instalar el SDK a trav茅s de Pipenv, agregando a Pipfile:

[packages]
transbank-sdk = '*'

y luego ejecutar:

pipenv install

Documentaci贸n

Puedes encontrar toda la documentaci贸n de c贸mo usar este SDK en el sitio https://www.transbankdevelopers.cl.

La documentaci贸n relevante para usar este SDK es:

Informaci贸n para contribuir y desarrollar este SDK

Requerimientos

  • Pipenv
  • Plugin de editorconfig para tu editor favorito.

Standares

  • Para los commits respetamos las siguientes normas: https://chris.beams.io/posts/git-commit/
  • Usamos ingles, para los mensajes de commit.
  • Se pueden usar tokens como WIP, en el subject de un commit, separando el token con :, por ejemplo: WIP: This is a useful commit message
  • Para los nombres de ramas tambi茅n usamos ingles.
  • Se asume, que una rama de feature no mezclada, es un feature no terminado.
  • El nombre de las ramas va en min煤sculas.
  • Las palabras se separan con -.
  • Las ramas comienzan con alguno de los short lead tokens definidos, por ejemplo: feat/tokens-configuration

Short lead tokens

Commits
  • WIP = Trabajo en progreso.
Ramas
  • feat = Nuevos features
  • chore = Tareas, que no son visibles al usuario.
  • bug = Resoluci贸n de bugs.

Todas las mezclas a master se hacen mediante Pull Request.

Test

Para ejecutar los test localmente debes usar el siguiente comando en una terminal.

pipenv run tests

Deploy de una nueva versi贸n.

Para generar una nueva versi贸n, se debe crear un PR (con un t铆tulo "Prepare release X.Y.Z" con los valores que correspondan para X, Y y Z). Se debe seguir el est谩ndar semver para determinar si se incrementa el valor de X (si hay cambios no retrocompatibles), Y (para mejoras retrocompatibles) o Z (si s贸lo hubo correcciones a bugs).

En ese PR deben incluirse los siguientes cambios:

  1. Modificar el archivo CHANGELOG.md para incluir una nueva entrada (al comienzo) para X.Y.Z que explique en espa帽ol los cambios de cara al usuario del SDK.
  2. Modificar version.py para que apunte a la nueva versi贸n X.Y.Z.

Luego de obtener aprobaci贸n del pull request, debe mezclarse a master e inmediatamente generar un release en GitHub con el tag vX.Y.Z. En la descripci贸n del release debes poner lo mismo que agregaste al changelog.

Con eso Travis CI generar谩 autom谩ticamente una nueva versi贸n de la librer铆a y la publicar谩 en PyPI.