Git Product home page Git Product logo

rutlib-py's Introduction

RUTlib-py

RUTlib's python library logo

PyPI version GitHub license

A Python library for parsing, validating, manipulating, generating, and formatting RUTs (Chilean identification).

Quick Installation

pip install RUTlib

The module exports the following functions:

  • clean_rut(rut: str) -> str
  • validate_rut(rut: str) -> bool
  • get_last_digit_of_rut(rut_numbers: int) -> str
  • format_rut(rut: str, with_dots: bool = True) -> str
  • generate_rut(length: int = 8, formatted: bool = True) -> str

Usage

Clean a RUT

This function takes a RUT as a string and removes all non-numeric characters, and transforms the input to uppercase.

from RUTlib import clean_rut

print(clean_rut('1.234-3'))  # 12343
print(clean_rut('1234-3'))   # 12343
print(clean_rut('12343'))    # 12343

Validate a RUT

This function checks whether a RUT is valid according to the RUT verification rules.

from RUTlib import validate_rut

print(validate_rut('1.234-3'))  # True
print(validate_rut('1234-3'))   # True
print(validate_rut('12343'))    # True
print(validate_rut('1.234-0'))  # False

Get Verificator Digit of a number

This function calculates the verification digit of a RUT.

from RUTlib import get_last_digit_of_rut

print(get_last_digit_of_rut(1234))  # 3
print(get_last_digit_of_rut(1235))  # 1

Format RUT

This function formats a RUT according to RUT conventions.

from RUTlib import format_rut

print(format_rut('12343'))       # 1.234-3
print(format_rut('12343', False)) # 1234-3

Generate a random RUT

This function generates a valid RUT randomly.

from RUTlib import generate_rut

print(generate_rut())          # Example: 12.345.678-5 (random)
print(generate_rut(7, False))  # Example: 1234567-5 (random)

Support the Project

"Buy Me A Coffee"

If you'd like to contribute

If you want to contribute to this module, please create Issues in the repository or submit Pull Requests. Remember to follow the code of conduct and best practices for clean code.

Any changes in the logic of the module's functions should be properly tested and documented.

More information

For more information about the RUT, consult the following link: RUT (Chile)


Version 0.1.3

rutlib-py's People

Contributors

fvergaracl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.