correiospy

Calculates the amount of supplies through zip code. The values are found at WS the Correios in Brazil.

Installation

You can to install using pip:

pip install correiospy

Or through of source code with:

git clone https://github.com/guicarvalho/correiospy.git
cd correiospy
python setup.py install

For to verify success of installation run this command in shell:

python -c "import correiospy; print correiospy.VERSION"
[some version of code here]

Use mode:

You can calculate the freight and delivery time informing only one service code or many. For to calculate with one, see below:

# coding: utf-8

from correiospy.calculator import CalcPriceDeadline
from correiospy.format_order_codes import OrderFormats
from correiospy.service_codes import ServiceCodes


values = {'zip_code_sender': '14808400',
          'zip_code_receiver': '14805362',
          'order_weight': 0.100,
          'order_format': OrderFormats.BOX_PACKAGE_FORMAT,
          'order_length': 27,
          'order_height': 27,
          'order_width': 27,
          'order_diameter': 27,
          'declared_value': 0,
          'service_code': [ServiceCodes.SEDEX_VAREJO_CODE]
          }

calc = CalcPriceDeadline(**values)

content_json = calc.calculate()

print content_json

And for to calculate with many service code:

# coding: utf-8

from correiospy.calculator import CalcPriceDeadline
from correiospy.format_order_codes import OrderFormats
from correiospy.service_codes import ServiceCodes


values = {'zip_code_sender': '14808400',
          'zip_code_receiver': '14805362',
          'order_weight': '0.100',
          'order_format': OrderFormats.BOX_PACKAGE_FORMAT,
          'order_length': '27',
          'order_height': '27',
          'order_width': '27',
          'order_diameter': '27',
          'declared_value': '0',
          'service_code': [ServiceCodes.SEDEX_VAREJO_CODE, ServiceCodes.SEDEX_10_VAREJO_CODE]
          }

calc = CalcPriceDeadline(**values)

content_json = calc.calculate()

print content_json

The response is a JSON object, and must look like this:

// one service code

{"40010": {"own_hand": "0,00", "receiving_notice": "0,00", "code": "40010", "deadline": "1", "declared_value": "0,00", "saturday_delivery": "S", "additional_valueless": "14,00", "home_delivery": "S", "value": "14,00"}}

// many service code

{"40045": {"own_hand": "0,00", "receiving_notice": "0,00", "code": "40045", "deadline": "0", "declared_value": "0,00", "saturday_delivery": null, "additional_valueless": "0,00", "home_delivery": null, "value": "0,00"}, "40215": {"own_hand": "0,00", "receiving_notice": "0,00", "code": "40215", "deadline": "1", "declared_value": "0,00", "saturday_delivery": "S", "additional_valueless": "22,60", "home_delivery": "S", "value": "22,60"}, "40010": {"own_hand": "0,00", "receiving_notice": "0,00", "code": "40010", "deadline": "1", "declared_value": "0,00", "saturday_delivery": "S", "additional_valueless": "14,00", "home_delivery": "S", "value": "14,00"}, "40290": {"own_hand": "0,00", "receiving_notice": "0,00", "code": "40290", "deadline": "0", "declared_value": "0,00", "saturday_delivery": null, "additional_valueless": "0", "home_delivery": null, "value": "0"}, "41106": {"own_hand": "0,00", "receiving_notice": "0,00", "code": "41106", "deadline": "3", "declared_value": "0,00", "saturday_delivery": "N", "additional_valueless": "13,70", "home_delivery": "S", "value": "13,70"}}

For to search an address the package offers the FinderZipCode class. You can to pass one or a list of zip codes for to search. See below how to use:

# coding: utf-8

from correiospy.search_engine import FinderZipCode


finder = FinderZipCode()
finder.find_addess(14800432)  # one zip code
finder.find_addess(14808400, 14805362, 14800432)  # many zip code

The method return a JSON object:

{"14808400": {"complemento": "at\\u00e9 598/599", "bairro": "Jardim Del Rei", "cidade": "Araraquara", "logradouro": "Rua Antonio Mattar", "estado_info": {"area_km2": "248.222,801", "codigo_ibge": "35", "nome": "S\\u00e3o Paulo"}, "cep": "14808400", "cidade_info": {"area_km2": "1003,674", "codigo_ibge": "3503208"}, "estado": "SP"}, "14800432": {"bairro": "Vila Bela Vista", "cidade": "Araraquara", "logradouro": "Rua Victor Lacorte", "estado_info": {"area_km2": "248.222,801", "codigo_ibge": "35", "nome": "S\\u00e3o Paulo"}, "cep": "14800432", "cidade_info": {"area_km2": "1003,674", "codigo_ibge": "3503208"}, "estado": "SP"}, "14805362": {"bairro": "Ch\\u00e1cara Flora Araraquara", "cidade": "Araraquara", "logradouro": "Rua Ad\\u00e3o Aroni", "estado_info": {"area_km2": "248.222,801", "codigo_ibge": "35", "nome": "S\\u00e3o Paulo"}, "cep": "14805362", "cidade_info": {"area_km2": "1003,674", "codigo_ibge": "3503208"}, "estado": "SP"}}

This package is under development.