brazilcep

v6.5.0

Minimalist and easy-to-use python library designed to query CEP (brazilian zip codes) data For more information about how to use this package see README

Latest version published 3 months ago

License: MIT

PyPI

GitHub

Package Health Score

76 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Popularity

Small

GitHub Stars: 210
Forks: 56
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package brazilcep, we found that it has been starred 210 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Sep 5, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like brazilcep is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 1
Last Release: 3 months ago
Last Commit: 2 days ago

Further analysis of the maintenance status of brazilcep based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that brazilcep demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 20
Funding: Yes

With more than 10 contributors for the brazilcep repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like brazilcep is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8

Age: 2 years
Latest Release: 3 months ago
Dependencies: 0 Direct
Versions: 9
Maintainers: 1
Wheels: OS Independent

Readme

BrazilCEP

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:

> [!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 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:

pip install brazilcep

> [!IMPORTANT] > 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:

&gt;&gt;&gt; import brazilcep

Now, call the get_address_from_cep to query any CEP:

&gt;&gt;&gt; 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:

 &gt;&gt;&gt; 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 from the official docs here.

Contribute

See this guideline here.

Credits

FAQs

What is brazilcep?

Minimalist and easy-to-use python library designed to query CEP (brazilian zip codes) data. Visit Snyk Advisor to see a full health score report for brazilcep, including popularity, security, maintenance & community analysis.

Is brazilcep popular?

The python package brazilcep receives a total of 4,505 weekly downloads. As such, brazilcep popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is brazilcep well maintained?

We found that brazilcep demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is brazilcep safe to use?

The python package brazilcep was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 22 November-2024, at 04:39 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP