Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brazanation/go-documents
Package to provide Brazilian Documents as "Value Objects" in Go
https://github.com/brazanation/go-documents
brasil brazil brazilian cartaosus cnh cnpj cns cpf cpf-validador documento documents golang judiciario judiciary pis renavam rg tituloeleitor
Last synced: about 20 hours ago
JSON representation
Package to provide Brazilian Documents as "Value Objects" in Go
- Host: GitHub
- URL: https://github.com/brazanation/go-documents
- Owner: brazanation
- License: mit
- Created: 2018-09-25T03:51:54.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-19T18:34:14.000Z (3 months ago)
- Last Synced: 2024-11-08T17:31:26.867Z (8 days ago)
- Topics: brasil, brazil, brazilian, cartaosus, cnh, cnpj, cns, cpf, cpf-validador, documento, documents, golang, judiciario, judiciary, pis, renavam, rg, tituloeleitor
- Language: Go
- Homepage:
- Size: 28.3 KB
- Stars: 44
- Watchers: 5
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Brazanation Documents - Golang
)
[](https://codecov.io/gh/brazanation/go-documents)
[](https://godoc.org/github.com/brazanation/go-documents)
[](https://goreportcard.com/report/github.com/brazanation/go-documents)
[](https://github.com/brazanation/go-documents/blob/master/LICENSE)
A Golang library to provide Brazilian Documents safer, easier and fun!
## Installation
go-documents requires Go 1.11 or later.
```
go get github.com/brazanation/go-documents
```
If you want to get an specific version, please use the example below:
```
go get gopkg.in/brazanation/go-documents.v0
```
## Development
### Requirements
- Install [Go](https://golang.org)
### Makefile
```sh
// Clean up
$ make clean
// Run tests and generates html coverage file
make cover
// Download project dependencies
make depend
// Format all go files
make fmt
// Run linters
make lint
// Run tests
make test
```
## Documentation
Read the full documentation at [https://godoc.org/github.com/brazanation/go-documents](https://godoc.org/github.com/brazanation/go-documents).
### CPF (cadastro de pessoas físicas)
Registration of individuals or Tax Identification
```go
doc, err := brdocs.NewCpf("06843273173")
if err != nil {
panic(err)
}
println(doc.String()) // prints 06843273173
println(doc.Format()) // prints 068.432.731-73
```
### CNPJ (cadastro nacional da pessoa jurídica)
Company Identification or National Register of Legal Entities
```go
doc, err := brdocs.NewCnpj("99999090910270")
if err != nil {
panic(err)
}
println(doc.String()) // prints 99999090910270
println(doc.Format()) // prints 99.999.090/9102-70
```
### CNH (carteira nacional de habilitação)
National Driving License
```go
doc, err := brdocs.NewCnh("83592802666")
if err != nil {
panic(err)
}
println(doc.String()) // prints 83592802666
println(doc.Format()) // prints 83592802666
```
### Cartão Nacional de Saúde (SUS)
National Health Card
```go
doc, err := brdocs.NewCns("242912018460005")
if err != nil {
panic(err)
}
println(doc.String()) // prints 242912018460005
println(doc.Format()) // prints 242 9120 1846 0005
```
### PIS/PASEP (programa de integração social e programa de formação do patrimônio do servidor público)
Social Integration Program and Training Program of the Heritage of Public Servant
```go
doc, err := brdocs.NewPisPasep("51823129491")
if err != nil {
panic(err)
}
println(doc.String()) // prints 51823129491
println(doc.Format()) // prints 518.23129.49-1
```
### Título de Eleitor
Voter Registration
```go
doc, err := brdocs.NewVoter("247003181023")
if err != nil {
panic(err)
}
println(doc.String()) // prints 247003181023
println(doc.Format()) // prints 247003181023
```
### Renavam (Registro Nacional de Veículos Automotores)
National Registry of Motor Vehicles
```go
doc, err := brdocs.NewRenavam("61855253306")
if err != nil {
panic(err)
}
println(doc.String()) // prints 61855253306
println(doc.Format()) // prints 6185.525330-6
```
## License
This project is released under the MIT licence. See [LICENSE](https://github.com/brazanation/go-documents/blob/master/LICENSE) for more details.