Skip to content

Commit d17b343

Browse files
committed
"Updated README.md with new table of contents, added development section, and updated version number in __init__.py"
1 parent 503c1e3 commit d17b343

File tree

3 files changed

+46
-7
lines changed

3 files changed

+46
-7
lines changed

README.md

+44-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable MD041 -->
12
[![PyPI version](https://img.shields.io/pypi/v/rutificador.svg)](https://pypi.org/project/rutificador/)
23
[![Python](https://img.shields.io/badge/Python-3.9%2B-blue)](https://www.python.org/)
34
[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
@@ -10,6 +11,27 @@
1011

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

14+
## Tabla de Contenidos
15+
16+
- [Rutificador](#rutificador)
17+
- [Tabla de Contenidos](#tabla-de-contenidos)
18+
- [Características](#características)
19+
- [Instalación](#instalación)
20+
- [Uso](#uso)
21+
- [Importar la clase Rut](#importar-la-clase-rut)
22+
- [Crear Un Objeto](#crear-un-objeto)
23+
- [Validar un RUT](#validar-un-rut)
24+
- [Calcular el Dígito Verificador de un RUT](#calcular-el-dígito-verificador-de-un-rut)
25+
- [Formatear un RUT](#formatear-un-rut)
26+
- [Validar y Formatear una lista de RUTs en diversos formatos](#validar-y-formatear-una-lista-de-ruts-en-diversos-formatos)
27+
- [Desarrollo](#desarrollo)
28+
- [Configuración del Entorno](#configuración-del-entorno)
29+
- [Ejecutar Pruebas](#ejecutar-pruebas)
30+
- [Problemas o Requerimientos](#problemas-o-requerimientos)
31+
- [Contribuciones](#contribuciones)
32+
- [Licencia](#licencia)
33+
- [Créditos](#créditos)
34+
1335
## Características
1436

1537
- Validación del formato del RUT.
@@ -122,6 +144,27 @@ print(xml_ruts)
122144
# </root>
123145
```
124146

147+
## Desarrollo
148+
149+
### Configuración del Entorno
150+
151+
1. Clonar el repositorio:
152+
git clone [https://github.com/cortega26/rutificador.git](https://github.com/cortega26/rutificador.git)
153+
cd rutificador
154+
155+
2. Crear un entorno virtual:
156+
python -m venv venv
157+
source venv/bin/activate # En Windows use venv\Scripts\activate
158+
159+
3. Instalar las dependencias de desarrollo:
160+
pip install -r requirements-dev.txt
161+
162+
### Ejecutar Pruebas
163+
164+
Para ejecutar las pruebas, use el siguiente comando:
165+
166+
pytest
167+
125168
## Problemas o Requerimientos
126169

127170
¿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.
@@ -132,7 +175,7 @@ Las contribuciones son bienvenidas. Solo debes hacer un fork del repositorio, cr
132175

133176
## Licencia
134177

135-
Este proyecto está licenciado bajo la Licencia MIT.
178+
Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.
136179

137180
## Créditos
138181

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "rutificador"
3-
version = "0.2.22"
3+
version = "0.2.23"
44
description = "Esta librería proporciona una implementación en Python para validar y formatear el Rol Único Tributario (RUT) utilizado en Chile."
55
authors = ["Carlos Ortega González <[email protected]>"]
66
license = "MIT"

rutificador/__init__.py

+1-5
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,11 @@
99
RutDigitoVerificador: Calcula y representa el dígito verificador de un RUT chileno.
1010
RutInvalidoError: Excepción personalizada para errores de RUT inválido.
1111
RutValidador: Valida un RUT chileno.
12-
13-
Versión: 0.2.22
14-
Autor: Carlos Ortega González
15-
Licencia: MIT
1612
"""
1713

1814
from typing import List
1915

20-
__version__ = "0.2.22"
16+
__version__ = "0.2.23"
2117
__author__ = "Carlos Ortega González"
2218
__license__ = "MIT"
2319

0 commit comments

Comments
 (0)