Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mstuttgart authored May 10, 2024
1 parent 94ff823 commit 6297f39
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,9 @@

## About

**BrazilCEP** is a minimalist and easy-to-use python library designed to query CEP (brazilian zip codes) data.
**BrazilCEP** is a minimalist and easy-to-use python library designed to query CEP (Postal Address Code) data.

Its objective is to provide a common query interface to all these search services, facilitating
the integration of Python applications with these services.
Its objective is to provide a common query interface to all these search services, facilitating the integration of Python applications with these services.

Currently supports several CEP API's:

Expand All @@ -60,6 +59,11 @@ Currently supports several CEP API's:
> **BrazilCEP** is the new name of former **PyCEPCorreio** python library.
If you want to migrate the old code to the new version, please see the [migrate](https://brazilcep.readthedocs.io/en/latest/migrate/) section in docs.

> [!TIP]
> **CEP** or **Código de Endereçamento Postal** (*Postal Address Code*), as it is also known, is a system of numeric codes, created, maintained and organized by *Correios do Brazil* for
> organizing addresses and deliveries of letters and parcels.

## Install

The recommended way to get BrazilCEP is to **install the latest stable release**
Expand All @@ -69,7 +73,7 @@ via [pip](http://pip-installer.org>):
pip install brazilcep
```

> [!NOTE]
> [!IMPORTANT]
> We currently support **Python 3.8+ only**. Users on older interpreter versions are urged to upgrade.
## How to Use
Expand Down Expand Up @@ -103,6 +107,14 @@ get all the address information we need from this object:

The CEP always must be a string.

> [!TIP]
> BrazilCEP was developed to integrate on-demand queries into web pages.
> Querying CEP in bulk through scripts or any other means is not recommended.
> [!IMPORTANT]
> BrazilCEP is not responsible for the functioning, availability and support of any of these query API's.
> All of them are provided by third parties, and this library just provides a handy way to centralize the CEP search on these services.
## Documentation

Documentation for the current version of BrazilCEP is available from the official docs [here](https://brazilcep.readthedocs.io/en/stable).
Expand Down

0 comments on commit 6297f39

Please sign in to comment.