diegosorrilha / pygseguro

Projeto para construir um Wrapper Python para a API do Pagseguro

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pygseguro

Projeto para construir um Wrapper Python para a API do Pagseguro versão 3

Build Status codecov Updates Python 3

Projeto escrito com Python 3. A linguagem utilizada também para codificar será o português por duas razões:

  1. O Pagseguro em si é um Gateway brasileiro com sua documentação em português
  2. Essa lib está sendo desenvolvida no como projeto prático da turma Luciano Ramlho do curso Python Pro

Contribuidores

Renzo Nuccitelli (@renzon)

Instalação

Instale o pipenv:

pip install pipenv

Para instalar a lib com pipenv:

pipenv install pygseguro

Como usar

Configuraçao Padrão

Utilize essa configuração se as chamadas costumam usar sempre a mesma configuração

>>> from pygseguro import set_config_padrao, get_config_padrao, ConfigConta
>>> get_config_padrao()
>>> cfg = ConfigConta(email='foo@bar.com', token='blah')
>>> set_config_padrao(cfg)
>>> get_config_padrao()
ConfigConta(email='foo@bar.com', token='blah')
>>> cfg.construir_url('/caminho')
'https://ws.pagseguro.uol.com.br/caminho?email=foo@bar.com&token=blah'

Você pode usar uma configuração por appId e appToken:

>>> from pygseguro import ConfigApp
>>> cfg_app = ConfigApp(app_id='1234', app_key='xpto')
>>> set_config_padrao(cfg_app)
>>> get_config_padrao()
ConfigApp(app_id='1234', app_key='xpto')
>>> cfg_app.construir_url('/outro_caminho')
'https://ws.pagseguro.uol.com.br/outro_caminho?appID=1234&appKey=xpto'

Como contribuir

Todo código segue a PEP8, com exceção do tamanho da linha, que aceita 120 caracteres. Toda função/classe/método/módulo deve possuir docstrings Toda função/método deve ter annotations

  1. Faça o fork do projeto e clone or projeto: git clone git@github.com:<seu_usuario>/pygseguro.git
  2. Instale o pipenv: pip install pipenv
  3. Instale as dependências de dev: pipenv install -d
  4. Desenvolva a feature com testes
  5. Rode os teste localmente: pipenv run pytest
  6. Envie o pull request com teste em um só commit
  7. Envie o PR para revisão
  8. Depois de revisado e corrigido, o PR será aceito e a lib postada no PyPi
  9. Coloque seu nome e username na porção contribuidores

About

Projeto para construir um Wrapper Python para a API do Pagseguro

License:GNU Affero General Public License v3.0


Languages

Language:Python 100.0%