Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/valentin-marquez/rut.py
rut.py: Librería Python para el manejo de RUTs chilenos.
https://github.com/valentin-marquez/rut.py
chile chilean-rut chilean-rut-utils formatting library python python3 utility validation
Last synced: about 1 month ago
JSON representation
rut.py: Librería Python para el manejo de RUTs chilenos.
- Host: GitHub
- URL: https://github.com/valentin-marquez/rut.py
- Owner: valentin-marquez
- Created: 2023-06-05T02:36:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-29T09:06:46.000Z (over 1 year ago)
- Last Synced: 2023-08-17T07:28:47.104Z (over 1 year ago)
- Topics: chile, chilean-rut, chilean-rut-utils, formatting, library, python, python3, utility, validation
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rut.py
Rut.py is a Python library for handling Chilean RUTs (Rol Único Tributario). It provides functions to clean, validate, get the check digit, format, and generate RUTs.
This library is based on the JavaScript library [rut.js](https://github.com/jlobos/rut.js) by jlobos. It aims to bring similar functionality to Python developers working with Chilean RUTs.
## Installation
You can install Rut.py using pip:
```shell
pip install rutpy
```
## Usage
To use RutPy, first import the necessary functions:
```python
from rutpy import clean, validate, get_check_digit, format, generate
```
You can then use the functions according to your needs.
### Clean
The `clean` function is used to remove dots and hyphens from a RUT:
```python
rut = "14.961.581-4"
clean_rut = clean(rut)
print(clean_rut) # Output: 149615814
```
### Validate
The `validate` function is used to check whether a RUT is valid or not:
```python
rut = "14.961.581-4"
is_valid = validate(rut)
print(is_valid) # Output: True
```
### Get Check Digit
The `get_check_digit` function is used to retrieve the check digit of a RUT:
```python
rut = "14.961.581"
check_digit = get_check_digit(rut)
print(check_digit) # Output: 4
```
### Format
The `format` function is used to format a RUT with dots and hyphen:
```python
rut = "14961581"
formatted_rut = format(rut)
print(formatted_rut) # Output: 14.961.581
```
### Generate
The `generate` function is used to generate a valid RUT:
```python
rut = generate()
print(rut) # Output: A randomly generated valid RUT
```
## Contributions
Contributions are welcome. If you find any issues, have any improvement ideas, or want to add new features, you can open an issue or submit a pull request on the [GitHub repository](https://github.com/NozzOne/rut.py).
## License
Rut.py is distributed under the [MIT License](https://opensource.org/licenses/MIT).