| Name | brazilcep JSON |
| Version |
6.2.0
JSON |
| download |
| home_page | |
| Summary | Minimalist and easy-to-use python library designed to query CEP (brazilian zip codes) data |
| upload_time | 2023-10-01 20:51:12 |
| maintainer | |
| docs_url | None |
| author | Michell Stuttgart |
| requires_python | >=3.8,<4.0 |
| license | MIT |
| keywords |
viacep
apicep
cep
brazil
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<a href="https://pypi.org/project/brazilcep/">
<img src="https://raw.githubusercontent.com/mstuttgart/brazilcep/develop/docs/static/logo.png" width="80%">
</a>
</p>
<p align="center">
<a href="https://github.com/mstuttgart/brazilcep/actions?query=workflow%3A%22Github+CI%22">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/mstuttgart/brazilcep/test-package.yml?color=3771a1&branch=develop&style=flat-square">
</a>
<a href="https://coveralls.io/github/mstuttgart/brazilcep">
<img alt="Coveralls github" src="https://img.shields.io/coveralls/github/mstuttgart/brazilcep?color=fcd800&style=flat-square">
</a>
<a href="https://www.codefactor.io/repository/github/mstuttgart/brazilcep">
<img alt="CodeFactor Grade" src="https://img.shields.io/codefactor/grade/github/mstuttgart/brazilcep/develop?color=fcd800&style=flat-square">
</a>
<a href="https://pypi.org/project/brazilcep">
<img src="https://img.shields.io/pypi/dm/brazilcep?color=fcd800&style=flat-square" alt="Downloads">
</a>
<a href="https://pypi.org/project/brazilcep">
<img src="https://img.shields.io/pypi/v/brazilcep.svg?style=flat-square" alt="Ratings">
</a>
<a href="https://pypi.org/project/brazilcep/">
<img src="https://img.shields.io/pypi/pyversions/brazilcep.svg?style=flat-square" alt="Version">
</a>
</p>
<p align="center">
<a href="#about">About</a> |
<a href="#install">Install</a> |
<a href="#how-to-use">How to Use</a> |
<a href="#documentation">Documentation</a>
<a href="#contribute">Contribute</a>
<a href="#credits">Credits</a>
</p>
## About
**BrazilCEP** is a minimalist and easy-to-use python library designed to query CEP (brazilian zip codes) data.
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:
- [ViaCEP](https://viacep.com.br)
- [ApiCEP (WideNet)](https://apicep.com)
> **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.
## Install
The recommended way to get BrazilCEP is to **install the latest stable release**
via [pip](http://pip-installer.org>):
```sh
pip install brazilcep
```
We currently support **Python 3.8+ only**. Users on older interpreter versions
are urged to upgrade.
## How to Use
Making a request is very simple. Begin by importing the BrazilCEP module:
```python
>>> import brazilcep
```
Now, call the `get_address_from_cep` to query any CEP:
```python
>>> address = brazilcep.get_address_from_cep('37503-130')
```
Now, we have a *dict* object called ``address``. We can
get all the address information we need from this object:
```python
>>> address
{
'district': 'rua abc',
'cep': '37503130',
'city': 'city ABC',
'street': 'str',
'uf': 'str',
'complement': 'str',
}
```
The CEP always must be a string.
## Documentation
Documentation for the current version of BrazilCEP is available from the official docs [here](https://brazilcep.readthedocs.io/en/stable).
## Contribute
See this *guideline* [here](https://github.com/mstuttgart/brazilcep/blob/develop/CONTRIBUTING.md).
## Credits
Copyright (C) 2016-2023 by Michell Stuttgart
Raw data
{
"_id": null,
"home_page": "",
"name": "brazilcep",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "viacep,apicep,cep,brazil",
"author": "Michell Stuttgart",
"author_email": "michellstut@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/81/a7/88153e49624f96e573f0639444757ae861decb1dead386661c30aaa5062d/brazilcep-6.2.0.tar.gz",
"platform": null,
"description": "\n<p align=\"center\">\n <a href=\"https://pypi.org/project/brazilcep/\">\n <img src=\"https://raw.githubusercontent.com/mstuttgart/brazilcep/develop/docs/static/logo.png\" width=\"80%\">\n </a>\n</p>\n\n<p align=\"center\">\n\n <a href=\"https://github.com/mstuttgart/brazilcep/actions?query=workflow%3A%22Github+CI%22\">\n <img alt=\"GitHub Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/mstuttgart/brazilcep/test-package.yml?color=3771a1&branch=develop&style=flat-square\">\n </a>\n\n <a href=\"https://coveralls.io/github/mstuttgart/brazilcep\">\n <img alt=\"Coveralls github\" src=\"https://img.shields.io/coveralls/github/mstuttgart/brazilcep?color=fcd800&style=flat-square\">\n </a>\n\n <a href=\"https://www.codefactor.io/repository/github/mstuttgart/brazilcep\">\n <img alt=\"CodeFactor Grade\" src=\"https://img.shields.io/codefactor/grade/github/mstuttgart/brazilcep/develop?color=fcd800&style=flat-square\">\n </a>\n\n <a href=\"https://pypi.org/project/brazilcep\">\n <img src=\"https://img.shields.io/pypi/dm/brazilcep?color=fcd800&style=flat-square\" alt=\"Downloads\">\n </a>\n\n <a href=\"https://pypi.org/project/brazilcep\">\n <img src=\"https://img.shields.io/pypi/v/brazilcep.svg?style=flat-square\" alt=\"Ratings\">\n </a>\n\n <a href=\"https://pypi.org/project/brazilcep/\">\n <img src=\"https://img.shields.io/pypi/pyversions/brazilcep.svg?style=flat-square\" alt=\"Version\">\n </a>\n\n</p>\n\n<p align=\"center\">\n <a href=\"#about\">About</a> |\n <a href=\"#install\">Install</a> |\n <a href=\"#how-to-use\">How to Use</a> |\n <a href=\"#documentation\">Documentation</a>\n <a href=\"#contribute\">Contribute</a>\n <a href=\"#credits\">Credits</a>\n</p>\n\n## About\n\n**BrazilCEP** is a minimalist and easy-to-use python library designed to query CEP (brazilian zip codes) data.\n\nIts objective is to provide a common query interface to all these search services, facilitating\nthe integration of Python applications with these services.\n\nCurrently supports several CEP API's:\n\n- [ViaCEP](https://viacep.com.br)\n- [ApiCEP (WideNet)](https://apicep.com)\n\n> **BrazilCEP** is the new name of former **PyCEPCorreio** python library.\n 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.\n\n## Install\n\nThe recommended way to get BrazilCEP is to **install the latest stable release**\nvia [pip](http://pip-installer.org>):\n\n```sh\npip install brazilcep\n```\n\nWe currently support **Python 3.8+ only**. Users on older interpreter versions\nare urged to upgrade.\n\n## How to Use\n\nMaking a request is very simple. Begin by importing the BrazilCEP module:\n\n```python\n>>> import brazilcep\n```\n\nNow, call the `get_address_from_cep` to query any CEP:\n\n```python\n>>> address = brazilcep.get_address_from_cep('37503-130')\n```\n\nNow, we have a *dict* object called ``address``. We can\nget all the address information we need from this object:\n\n```python\n >>> address\n{\n 'district': 'rua abc',\n 'cep': '37503130',\n 'city': 'city ABC',\n 'street': 'str',\n 'uf': 'str',\n 'complement': 'str',\n}\n```\n\nThe CEP always must be a string.\n\n## Documentation\n\nDocumentation for the current version of BrazilCEP is available from the official docs [here](https://brazilcep.readthedocs.io/en/stable).\n\n## Contribute\n\nSee this *guideline* [here](https://github.com/mstuttgart/brazilcep/blob/develop/CONTRIBUTING.md).\n\n## Credits\n\nCopyright (C) 2016-2023 by Michell Stuttgart\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Minimalist and easy-to-use python library designed to query CEP (brazilian zip codes) data",
"version": "6.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/mstuttgart/brazilcep/issues",
"Documentation": "https://brazilcep.readthedocs.io/en/stable/",
"Donation": "https://ko-fi.com/mstuttgart",
"Repository": "https://github.com/mstuttgart/brazilcep"
},
"split_keywords": [
"viacep",
"apicep",
"cep",
"brazil"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a0a707db1e999b210de724b64ac48f5dff7e05ca4f550a1bd203378493c71ffc",
"md5": "3f4456ee89c8e8f638e179ab21b335cd",
"sha256": "6a92bc9ed43a1261b73326e7edf8f5146190a76cf8ddf79319262163269939b5"
},
"downloads": -1,
"filename": "brazilcep-6.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f4456ee89c8e8f638e179ab21b335cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 10668,
"upload_time": "2023-10-01T20:51:10",
"upload_time_iso_8601": "2023-10-01T20:51:10.727116Z",
"url": "https://files.pythonhosted.org/packages/a0/a7/07db1e999b210de724b64ac48f5dff7e05ca4f550a1bd203378493c71ffc/brazilcep-6.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "81a788153e49624f96e573f0639444757ae861decb1dead386661c30aaa5062d",
"md5": "bfe1ef6db1e840ea3f83f2e9faba2af2",
"sha256": "e37fad8e80a37254ad9cb905b1b512416784c52aef63eade1514a84b8059b08f"
},
"downloads": -1,
"filename": "brazilcep-6.2.0.tar.gz",
"has_sig": false,
"md5_digest": "bfe1ef6db1e840ea3f83f2e9faba2af2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 7687,
"upload_time": "2023-10-01T20:51:12",
"upload_time_iso_8601": "2023-10-01T20:51:12.927559Z",
"url": "https://files.pythonhosted.org/packages/81/a7/88153e49624f96e573f0639444757ae861decb1dead386661c30aaa5062d/brazilcep-6.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-01 20:51:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mstuttgart",
"github_project": "brazilcep",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "brazilcep"
}
