BrazilCEP: Query CEP Easily™¶

BrazilCEP is a minimalist and easy-to-use Python library designed to query CEP (Postal Address Code) data.

—

Quick Example¶

Here’s a simple usage example:

>>> import brazilcep
>>> brazilcep.get_address_from_cep('37503-130')
{
    'district': 'rua abc',
    'cep': '37503130',
    'city': 'city ABC',
    'street': 'str',
    'uf': 'str',
    'complement': 'str',
}

Its goal is to provide a unified query interface for multiple search services, simplifying the integration of Python applications with these services.

Starting from version 7.0.0, BrazilCEP introduces support for asynchronous operations.

Supported CEP APIs¶

Currently, BrazilCEP supports the following CEP APIs:

What is CEP?¶

CEP or Código de Endereçamento Postal (Postal Address Code) is a system of numeric codes created, maintained, and organized by Correios do Brasil to streamline address organization and the delivery of letters and parcels.

Documentation Overview¶

User Guide¶

This section provides background information and step-by-step instructions for using BrazilCEP.

API Documentation¶

For details on specific functions, classes, or methods, refer to this section.

API Reference

Contributor Guide¶

If you want to contribute to the project, this section provides all the necessary guidelines.

Contributing
- Bug Reports and Feature Requests
  - Found a Bug?
  - Have a Suggestion for an Enhancement or New Feature?
- Contributing Fixes and New Features

Release History¶

For a detailed changelog of the project, refer to this section.

Changelog