Skip to content

Commit

Permalink
"Updated README.md with new table of contents, added development sect…
Browse files Browse the repository at this point in the history
…ion, and updated version number in __init__.py"
  • Loading branch information
cortega26 committed Oct 13, 2024
1 parent 503c1e3 commit d17b343
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 7 deletions.
45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- markdownlint-disable MD041 -->
[![PyPI version](https://img.shields.io/pypi/v/rutificador.svg)](https://pypi.org/project/rutificador/)
[![Python](https://img.shields.io/badge/Python-3.9%2B-blue)](https://www.python.org/)
[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
Expand All @@ -10,6 +11,27 @@

Una biblioteca Python para validar y formatear RUTs (Rol Único Tributario) chilenos.

## Tabla de Contenidos

- [Rutificador](#rutificador)
- [Tabla de Contenidos](#tabla-de-contenidos)
- [Características](#características)
- [Instalación](#instalación)
- [Uso](#uso)
- [Importar la clase Rut](#importar-la-clase-rut)
- [Crear Un Objeto](#crear-un-objeto)
- [Validar un RUT](#validar-un-rut)
- [Calcular el Dígito Verificador de un RUT](#calcular-el-dígito-verificador-de-un-rut)
- [Formatear un RUT](#formatear-un-rut)
- [Validar y Formatear una lista de RUTs en diversos formatos](#validar-y-formatear-una-lista-de-ruts-en-diversos-formatos)
- [Desarrollo](#desarrollo)
- [Configuración del Entorno](#configuración-del-entorno)
- [Ejecutar Pruebas](#ejecutar-pruebas)
- [Problemas o Requerimientos](#problemas-o-requerimientos)
- [Contribuciones](#contribuciones)
- [Licencia](#licencia)
- [Créditos](#créditos)

## Características

- Validación del formato del RUT.
Expand Down Expand Up @@ -122,6 +144,27 @@ print(xml_ruts)
# </root>
```

## Desarrollo

### Configuración del Entorno

1. Clonar el repositorio:
git clone [https://github.com/cortega26/rutificador.git](https://github.com/cortega26/rutificador.git)
cd rutificador

2. Crear un entorno virtual:
python -m venv venv
source venv/bin/activate # En Windows use venv\Scripts\activate

3. Instalar las dependencias de desarrollo:
pip install -r requirements-dev.txt

### Ejecutar Pruebas

Para ejecutar las pruebas, use el siguiente comando:

pytest

## Problemas o Requerimientos

¿Te gustaría reportar algún error, solicitar alguna modificación o característica adicional en esta librería? Solo debes abrir un `issue` y describir tu petición de la forma más precisa y clara posible.
Expand All @@ -132,7 +175,7 @@ Las contribuciones son bienvenidas. Solo debes hacer un fork del repositorio, cr

## Licencia

Este proyecto está licenciado bajo la Licencia MIT.
Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.

## Créditos

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "rutificador"
version = "0.2.22"
version = "0.2.23"
description = "Esta librería proporciona una implementación en Python para validar y formatear el Rol Único Tributario (RUT) utilizado en Chile."
authors = ["Carlos Ortega González <carlosortega77@gmail.com>"]
license = "MIT"
Expand Down
6 changes: 1 addition & 5 deletions rutificador/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,11 @@
RutDigitoVerificador: Calcula y representa el dígito verificador de un RUT chileno.
RutInvalidoError: Excepción personalizada para errores de RUT inválido.
RutValidador: Valida un RUT chileno.
Versión: 0.2.22
Autor: Carlos Ortega González
Licencia: MIT
"""

from typing import List

__version__ = "0.2.22"
__version__ = "0.2.23"
__author__ = "Carlos Ortega González"
__license__ = "MIT"

Expand Down

0 comments on commit d17b343

Please sign in to comment.