Skip to main content

Simples wrapper para API de licitações da Prefeitura de São Paulo

Project description

sp_licitacoesPy

Simples wrapper, em desenvolvimento, para API de licitações da Prefeitura de São Paulo

Este pacote foi feito para que não seja mais nescessário montar uma requisição manual (usando urrlib ou requests, por exemplo) para API. Agora basta algumas linhas de código:

from sp_licitacoesPy import licitacoes
token = '------------' # Seu token aqui!

# Retorna uma lista com 35 licitações do ano de 2009.
dados = licitacoes.obter_dados(token, ano = 2009, quantidade = 35)

Instalação

Para instalar, basta usar o PyPi:

você@máquina:$ pip install sp_licitacoesPy

Agora, é nescessário criar uma conta na Vitrine de APIs da Cidade de São Paulo. É preciso se inscrever na API Licitacoes - v1, e então gerar um token dentro de Applications na Default Application na aba Production Keys, onde aparecerá um botão de gerar um Access Token.

Este token é necessário na verificação da solicitação para a API. Sem ele o pacote não funciona :/

Note que o Access Token gerado tem um tempo limite de 3600 segundos!

Uso

Todas as funções nescessárias estão dentro de um único arquivo licitacoes.py dentro do pacote. São duas as funções mais importantes:

  • resposta_json()

    • Esta função constrói um URL para solicitação à API, e retorna a resposta JSON em um dicionário.
  • obter_dados()

    • Esta função que "limpa" a resposta JSON da API, e retorna uma lista de dicionários com as licitações.

Parâmetros para ambas as funções:

token ano = 2008 quantidade = 1 offset = 0
obrigatório opcional opcional opcional
str int int int
deve ser válido 2008<= ano <= 2019 < 10.000 < 10.000

Note que o valor quatidade + offset também não pode ser superior ao de 10.000

  • token: é aquele gerado pela próptia Vitirine de APIs. Se este não for válido, resultará em um erro "Token_Invalido"

  • ano: o ano da(s) licitação(ões) desejada(s), este deve estar entre 2008 e 2019. O valor padrão é o ano de 2008.

  • quantidade: a quatidade de licitações desejadas, que não deve ultrapassar 10.000. O valor padrão é de 1 (uma licitação apenas).

  • offset: se refere a paginação da base de dados das licitações, este não deve ultrapassar o valor de 10.000. O valor padrão é de 0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sp_licitacoesPy-0.0.2.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

sp_licitacoesPy-0.0.2-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file sp_licitacoesPy-0.0.2.tar.gz.

File metadata

  • Download URL: sp_licitacoesPy-0.0.2.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.9

File hashes

Hashes for sp_licitacoesPy-0.0.2.tar.gz
Algorithm Hash digest
SHA256 8896dbb5a8a5f09be991e74d39867f40dcb44386963be47fd04d4f36c4914f57
MD5 1472d95b270d5a1711cc0e3d481a7336
BLAKE2b-256 3541ce9dbd98f246ee74903db51f73c2ca56bb1896b4b0a56756b99566080494

See more details on using hashes here.

File details

Details for the file sp_licitacoesPy-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: sp_licitacoesPy-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.9

File hashes

Hashes for sp_licitacoesPy-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 eafe4d3a9484db6a9ade367bbf792ba9c201867bc3d0664946ed967f5d6b2396
MD5 a819f01c8e1ffb0403866400c243c107
BLAKE2b-256 daebb4a107f1328bb466a79b313563a2f28a27d5609a70266979eaae08224e6e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page