brazilian-utils / python

[DEPRECATED] Utils library for Brazilian-specific businesses.

🇧🇷 Brazilian Utils

Utils library for Brazilian-specific businesses.

📖 Documentation

---

Vidas Negras Importam | Black Lives Matter. ✊🏽✊🏾✊🏿

To know how to help, just go to Vidas Negras Importam or Black Lives Matter.

---

We are changing

After one year of Brazilian Utils and lots of feedback, we decided to refactor our library to fix issues, create a website and make it easier for other developers to contribute. If you use v0 version, please, check v0 branch.

---

Table of Contents

• Getting Started
  • Installation
  • Usage
  • Contributors
  • License

Getting Started

Brazilian Utils is a library focused on solving problems that we face daily in the development of applications for the Brazilian business.

Installation

Using Brazilian Utils is quite simple and you can use it in some ways:

as npm package:

npm install --save @brazilian-utils/brazilian-utils

with yarn package manager:

yarn add @brazilian-utils/brazilian-utils

or <script> tag (global brazilianUtils):

<script src="https://unpkg.com/@brazilian-utils/brazilian-utils/dist/brazilian-utils.cjs.production.min.js"></script>

Usage

To use one of our utilities you just need to import the required function as in the example below:

import { isValidCPF } from '@brazilian-utils/brazilian-utils';

isValidCPF('1232454233345'); // false

You can check a list of utilities by clicking here.

Contributors

Our "thank you" goes to these wonderful people (emoji key):

Hyan Mandian 💻 📖 🤔 ⚠️	Lucas Veloso 💻 📖 🤔 ⚠️	Andreo Vieira 💻 📖 🤔 🔧	Matheus Almeida 💻 📖 ⚠️	Fernando Rogelin 💻 📖 ⚠️	rodineijf 💻 📖 ⚠️	Emerson Laurentino 💻 📖 ⚠️
Leonardo Dutra 💻 📖 ⚠️	Victor Magalhães 💻 🔧	Amauri Dias 💻 🔧	Felipe F. Diogo 💻 ⚠️	Alan Raso 💻 ⚠️	Felipe Fetter 📖	Rafael Franco 💻 📖
Rafael Pezzetti 💻 ⚠️ 📖	Antonio Roberto Furlaneto 💻 📖 ⚠️	Felipe Nolleto Nascimento 💻 📖 ⚠️	Saulo Joab 📖	Pedro Arantes 💻 📖 ⚠️	Silvio Clécio 💻 📖 ⚠️	Lucas Nascimento 💻
Lincon Kusunoki 💻 📖 ⚠️	Marcelo Cristiano 💻 📖 ⚠️	Tarcísio Batista de Freitas Junior 📖	Lucas Carrias 📖 ⚠️ 💻 🔧

This project follows the all-contributors specification. Contributions of any kind are welcome!

License

MIT

python's Issues

Could I merge with the organization?

I literally wrote a Python package which is already on pip with the same name as this project 2 years ago, currently supporting CPF and CNPJ.

Could I suggest not doing (at least the python part) from scratch and merging my project with this organization?

https://github.com/luizberti/brutils

Regarding the future of this package

Hey @camilamaia! I noticed that you've been cleaning up this project recently, so I have a proposal to make:

Historical Context

I am the owner of the brutils package in PyPI, which predates the brazilian-utils package and organization by about roughly 2 years if I recall correctly.

My project (unlike most in the Python ecosystem, including this one), is thoroughly documented both in Portuguese and English, is thoroughly tested and fully supports both python 2.7 and 3.x (2.7 is still important for legacy applications), exposes an ergonomic and type-hinted API with additional utility functions, and doesn't suffer from extensive code quality issues like some others do (even on this one, validate_first_digit and validate_second_digit are a clear smell of code duplication, as they are almost identical and implement the same checksumming algorithm, but in different positions in the array).

Mine also has the benefit that it already implements CNPJ which this one doesn't, and its internal architecture was made to favor extending the package with support for other types of documents by simply adding more internal modules. Also, like this one, it has zero dependencies outside of Python itself (although the tests can be ran with pytest as well if preferred).

When this organization started a few years ago, I offered to transfer my package so that it would be maintained under it, but that conversation died out and nothing was done.

The Proposal

Given the renewed interest in this package from you, what would you say to us instead of trying to refactor this package into a better shape, transfer mine to the organization (both here and in PyPI) making it the official one, and deprecating this one?

It would lessen the maintenance burden for everyone, and de-fragment the ecosystem (especially since my crate is very old and shares a very similar name)

What do you say? 😃

Regards, Luiz.