| Name | brazilcep JSON |
| Version |
6.7.0
JSON |
| download |
| home_page | None |
| Summary | Minimalist and easy-to-use python library designed to query CEP (brazilian zip codes) data |
| upload_time | 2024-11-25 13:24:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2016-2024, Michell Stuttgart Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h2 align="center">
<a href="https://pypi.org/project/brazilcep/">
<img src="https://github.com/mstuttgart/brazilcep/assets/8174740/fb7c86c8-6261-4300-b2e0-65877084d865" width="15%">
</a>
<br>
BrazilCEP
</h2>
<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.yml?color=fcd800&branch=main">
</a>
<a href="https://codecov.io/gh/mstuttgart/brazilcep" >
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/mstuttgart/brazilcep?color=fcd800">
</a>
<a href="https://brazilcep.readthedocs.io/" >
<img alt="readthedocs" src="https://img.shields.io/readthedocs/brazilcep?color=fcd800">
</a>
<a href="https://pypi.org/project/brazilcep">
<img src="https://img.shields.io/pypi/dm/brazilcep?color=fcd800" alt="Downloads">
</a>
<a href="https://pypi.org/project/brazilcep">
<img src="https://img.shields.io/pypi/v/brazilcep.svg?" alt="Ratings">
</a>
<a href="https://pypi.org/project/brazilcep/">
<img src="https://img.shields.io/pypi/pyversions/brazilcep.svg" alt="Version">
</a>
</p>
<p align="center">
<a href="#about">About</a> |
<a href="#install">Install</a> |
<a href="#quick-start">Quick Start</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 (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.
Currently supports several CEP API's:
- [ViaCEP](https://viacep.com.br)
- [ApiCEP (WideNet)](https://apicep.com)
- [OpenCEP](https://opencep.com/)
> [!NOTE]
> **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/api.html#migrate-from-pycepcorreios) 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**
via [pip](http://pip-installer.org>):
```sh
pip install brazilcep
```
## Quick Start
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.
> [!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 [here](https://brazilcep.readthedocs.io/).
## Contribute
See this _guideline_ [here](https://brazilcep.readthedocs.io/contributing.html).
## Credits
Copyright (C) 2016-2024 by Michell Stuttgart
Raw data
{
"_id": null,
"home_page": null,
"name": "brazilcep",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Michell Stuttgart <michellstut@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/82/dc/ad15b6b90f35636142099a5d911899fba58d0c6d0b787fa7a1138f95f8dd/brazilcep-6.7.0.tar.gz",
"platform": null,
"description": "<h2 align=\"center\">\n <a href=\"https://pypi.org/project/brazilcep/\">\n <img src=\"https://github.com/mstuttgart/brazilcep/assets/8174740/fb7c86c8-6261-4300-b2e0-65877084d865\" width=\"15%\">\n </a>\n <br>\n BrazilCEP\n</h2>\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.yml?color=fcd800&branch=main\">\n </a>\n\n <a href=\"https://codecov.io/gh/mstuttgart/brazilcep\" >\n <img alt=\"Codecov\" src=\"https://img.shields.io/codecov/c/github/mstuttgart/brazilcep?color=fcd800\">\n </a>\n\n<a href=\"https://brazilcep.readthedocs.io/\" >\n <img alt=\"readthedocs\" src=\"https://img.shields.io/readthedocs/brazilcep?color=fcd800\">\n </a>\n\n <a href=\"https://pypi.org/project/brazilcep\">\n <img src=\"https://img.shields.io/pypi/dm/brazilcep?color=fcd800\" alt=\"Downloads\">\n </a>\n\n <a href=\"https://pypi.org/project/brazilcep\">\n <img src=\"https://img.shields.io/pypi/v/brazilcep.svg?\" alt=\"Ratings\">\n </a>\n\n <a href=\"https://pypi.org/project/brazilcep/\">\n <img src=\"https://img.shields.io/pypi/pyversions/brazilcep.svg\" 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=\"#quick-start\">Quick Start</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 (Postal Address Code) data.\n\nIts objective is to provide a common query interface to all these search services, facilitating the 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- [OpenCEP](https://opencep.com/)\n\n> [!NOTE]\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/api.html#migrate-from-pycepcorreios) section in docs.\n\n> [!TIP]\n> **CEP** or **C\u00f3digo de Endere\u00e7amento Postal** (_Postal Address Code_), as it is also known, is a system of numeric codes, created, maintained and organized by _Correios do Brazil_ for\n> organizing addresses and deliveries of letters and parcels.\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\n## Quick Start\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> [!TIP]\n> BrazilCEP was developed to integrate on-demand queries into web pages.\n> Querying CEP in bulk through scripts or any other means is not recommended.\n\n> [!IMPORTANT]\n> BrazilCEP is not responsible for the functioning, availability and support of any of these query API's.\n> All of them are provided by third parties, and this library just provides a handy way to centralize the CEP search on these services.\n\n## Documentation\n\nDocumentation for the current version of BrazilCEP is available [here](https://brazilcep.readthedocs.io/).\n\n## Contribute\n\nSee this _guideline_ [here](https://brazilcep.readthedocs.io/contributing.html).\n\n## Credits\n\nCopyright (C) 2016-2024 by Michell Stuttgart\n",
"bugtrack_url": null,
"license": " MIT License Copyright (c) 2016-2024, Michell Stuttgart Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Minimalist and easy-to-use python library designed to query CEP (brazilian zip codes) data",
"version": "6.7.0",
"project_urls": {
"Changelog": "https://github.com/mstuttgart/brazilcep/blob/main/CHANGELOG",
"Documentation": "https://brazilcep.readthedocs.io/index.html",
"Repository": "https://github.com/mstuttgart/brazilcep",
"Tracker": "https://github.com/mstuttgart/brazilcep/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "55296e897aaa0235fb86f05c5fac4bcaab50adb934960050cf378568e52f7afc",
"md5": "7a9b4a5736df7236c41afa3f0e07d858",
"sha256": "702bd18e3e9ae30118d6fc60681af68a3b7c2b1035db76c0c2de856135c820da"
},
"downloads": -1,
"filename": "brazilcep-6.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a9b4a5736df7236c41afa3f0e07d858",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10834,
"upload_time": "2024-11-25T13:24:02",
"upload_time_iso_8601": "2024-11-25T13:24:02.392050Z",
"url": "https://files.pythonhosted.org/packages/55/29/6e897aaa0235fb86f05c5fac4bcaab50adb934960050cf378568e52f7afc/brazilcep-6.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "82dcad15b6b90f35636142099a5d911899fba58d0c6d0b787fa7a1138f95f8dd",
"md5": "82921ead0594f0912d91d875cd213561",
"sha256": "d86f9264ec80c5069281d4ee3bb1297c389143da34bee18ef970a5fa35a6c059"
},
"downloads": -1,
"filename": "brazilcep-6.7.0.tar.gz",
"has_sig": false,
"md5_digest": "82921ead0594f0912d91d875cd213561",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12461,
"upload_time": "2024-11-25T13:24:03",
"upload_time_iso_8601": "2024-11-25T13:24:03.887093Z",
"url": "https://files.pythonhosted.org/packages/82/dc/ad15b6b90f35636142099a5d911899fba58d0c6d0b787fa7a1138f95f8dd/brazilcep-6.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 13:24:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mstuttgart",
"github_project": "brazilcep",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "brazilcep"
}
