https://github.com/tommasocerruti/codice-fiscale

Elixir library to calculate and check Italian tax code (codice fiscale).
https://github.com/tommasocerruti/codice-fiscale

codice-fiscale elixir generator validator

Last synced: about 1 month ago
JSON representation

Elixir library to calculate and check Italian tax code (codice fiscale).

• Host: GitHub
• URL: https://github.com/tommasocerruti/codice-fiscale
• Owner: tommasocerruti
• License: mit
• Created: 2024-06-30T17:28:08.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-07-08T08:32:48.000Z (4 months ago)
• Last Synced: 2024-09-30T09:01:56.653Z (about 2 months ago)
• Topics: codice-fiscale, elixir, generator, validator
• Language: Elixir
• Homepage:
• Size: 124 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README-it.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CodiceFiscale

[![Linguaggio](https://img.shields.io/badge/linguaggio-elixir-purple.svg)](https://elixir-lang.org/)

[![Licenza](https://img.shields.io/badge/licenza-MIT-green.svg)](https://opensource.org/licenses/MIT)

[![Contributi](https://img.shields.io/badge/contributi-benvenuti-brightgreen.svg)](CONTRIBUTING.md)

`CodiceFiscale` è una libreria [Elixir](https://elixir-lang.org/) che fornisce diverse funzioni relative al codice fiscale italiano.   

Essa permette di generare un codice fiscale basato su dati anagrafici e di verificare se un codice fiscale fornito corrisponde ai dati anagrafici forniti.   

La documentazione è disponibile su https://hexdocs.pm/codice_fiscale.   

*To read this README in English, click [here](./README.md).*

## Funzionalità

- **Calcolo del Codice Fiscale:** Dato un nome, cognome, data di nascita, sesso e [codice catastale](https://it.wikipedia.org/wiki/Codice_catastale) del luogo di nascita, calcola il corrispondente codice fiscale.

- **Verifica del Codice Fiscale:** Controlla se un codice fiscale fornito corrisponde al codice fiscale atteso basato sui dati anagrafici forniti.

## Installazione

Aggiungi `CodiceFiscale` come dipendenza nel tuo file `mix.exs`:

```elixir

defp deps do

  [

    {:codice_fiscale, "~> 0.1.1"}

  ]

end

```

Quindi, scarica le dipendenze:

```shell

$ mix deps.get

```

## Utilizzo

### Calcolo del Codice Fiscale

Calcola il codice fiscale dati nome, cognome, data di nascita, sesso e codice catastale del luogo di nascita.

```elixir

iex> CodiceFiscale.calcola("Mario", "Rossi", "1980-01-01", "M", "H501")

{:ok, "RSSMRA80A01H501U"}

```

### Verifica del Codice Fiscale

Verifica se il codice fiscale corrisponde ai dati anagrafici forniti.   

```elixir

iex> CodiceFiscale.verifica("RSSMRA80A01H501U", %{nome: "Mario", cognome: "Rossi", data_nascita: "1980-01-01", sesso: "M", codice: "H501"})

{:ok, "Il codice fiscale corrisponde ai dati anagrafici."}

```

## Configurazione

Per abilitare il logging, imposta la chiave :logging_enabled a true nell'ambiente della tua applicazione:  

```elixir

config :codice_fiscale, logging_enabled: true

```

## Contributi

I contributi sono benvenuti! Non esitare a inviare issue e pull request.   

Prima di contribuire, leggi [qui](CONTRIBUTING.md).

## Licenza

Questa libreria è rilasciata sotto la Licenza MIT.