rut-validator 0.1.0__tar.gz

rut_validator-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Eli-ezer Reuven Ramirez Ruiz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rut_validator-0.1.0/PKG-INFO

@@ -0,0 +1,223 @@
+Metadata-Version: 2.4
+Name: rut-validator
+Version: 0.1.0
+Summary: Chilean RUT validation library with Pydantic, Django, and SQLAlchemy support
+License: MIT
+License-File: LICENSE
+Keywords: rut,chile,validation,pydantic,django,sqlalchemy,fastapi
+Author: Eli-ezer Reuven Ramirez Ruiz
+Author-email: ramirez.ruiz.eliezer.reuven@gmail.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Provides-Extra: dev
+Provides-Extra: docs
+Provides-Extra: fastapi
+Provides-Extra: pydantic
+Requires-Dist: black ; extra == "dev"
+Requires-Dist: click (>=8.0.0,<9.0.0)
+Requires-Dist: django (>=3.2,<5.0)
+Requires-Dist: fastapi (>=0.111.0,<1.0.0) ; extra == "fastapi"
+Requires-Dist: flake8 ; extra == "dev"
+Requires-Dist: isort ; extra == "dev"
+Requires-Dist: mypy ; extra == "dev"
+Requires-Dist: myst-parser ; extra == "docs"
+Requires-Dist: pre-commit ; extra == "dev"
+Requires-Dist: pydantic (>=2.12.5,<3.0.0) ; extra == "pydantic"
+Requires-Dist: pytest (>=7.0.0) ; extra == "dev"
+Requires-Dist: pytest-cov ; extra == "dev"
+Requires-Dist: ruff ; extra == "dev"
+Requires-Dist: sphinx ; extra == "docs"
+Requires-Dist: sphinx-rtd-theme ; extra == "docs"
+Requires-Dist: sqlalchemy (>=2.0.49,<3.0.0)
+Project-URL: Changelog, https://github.com/yourusername/rut-validator/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://rut-validator.readthedocs.io/
+Project-URL: Homepage, https://github.com/yourusername/rut-validator
+Project-URL: Issues, https://github.com/yourusername/rut-validator/issues
+Project-URL: Repository, https://github.com/yourusername/rut-validator
+Description-Content-Type: text/markdown
+
+# rut-validator
+
+[![PyPI version](https://badge.fury.io/py/rut-validator.svg)](https://pypi.org/project/rut-validator/)
+[![Python versions](https://img.shields.io/pypi/pyversions/rut-validator.svg)](https://pypi.org/project/rut-validator/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/yourusername/rut-validator/workflows/CI/badge.svg)](https://github.com/yourusername/rut-validator/actions)
+[![codecov](https://codecov.io/gh/yourusername/rut-validator/branch/main/graph/badge.svg)](https://codecov.io/gh/yourusername/rut-validator)
+[![Documentation Status](https://readthedocs.org/projects/rut-validator/badge/?version=latest)](https://rut-validator.readthedocs.io/en/latest/?badge=latest)
+
+Librería para validar RUT chileno con enfoque Pydantic-first y soporte completo para frameworks web.
+
+## ✨ Características
+
+- ✅ **Validación pura de RUT chileno** usando algoritmo módulo 11
+- ✅ **Detección automática de formato**: dotted (`12.345.678-9`), hyphenated (`12345678-9`), numeric (`123456789`)
+- ✅ **Integración completa con Pydantic** (`RutStr`)
+- ✅ **Campo Django** (`RUTField`) listo para usar
+- ✅ **Tipo SQLAlchemy** (`RutSQLAlchemy`) para bases de datos
+- ✅ **Compatible con FastAPI** y otros frameworks web
+- ✅ **Type hints completos** para mejor desarrollo
+- ✅ **Sin dependencias externas** para funcionalidad core
+- ✅ **Tests exhaustivos** con alta cobertura
+
+## 🚀 Instalación
+
+```bash
+pip install rut-validator
+
+# Con soporte Pydantic
+pip install rut-validator[pydantic]
+
+# Con soporte FastAPI
+pip install rut-validator[fastapi]
+
+# Para desarrollo
+pip install rut-validator[dev]
+```
+
+## 📖 Uso Básico
+
+### Validación Simple
+
+```python
+from rut_validator import RutValidator
+
+# Validar RUT con cualquier formato
+rut = RutValidator.validate("20.884.437-7")
+print(f"RUT válido: {rut.formatted}")  # "20.884.437-7"
+print(f"Número: {rut.number}")          # 20884437
+print(f"Dígito: {rut.digit}")          # "7"
+print(f"Formato: {rut.format}")        # RutFormat.DOTTED
+```
+
+### Detección de Formato
+
+```python
+from rut_validator import RutValidator
+
+# La librería detecta automáticamente el formato de entrada
+formats = [
+    "20.884.437-7",  # Formato dotted
+    "20884437-7",    # Formato hyphenated
+    "208844377",     # Formato numeric
+]
+
+for rut_str in formats:
+    rut = RutValidator.validate(rut_str)
+    print(f"'{rut_str}' -> Formato: {rut.format}, Es dotted: {rut.is_dotted}")
+```
+
+### Con Pydantic
+
+```python
+from pydantic import BaseModel
+from rut_validator import RutStr
+
+class User(BaseModel):
+    name: str
+    rut: RutStr  # Validación automática
+
+# Uso
+user = User(name="Juan Pérez", rut="12.345.678-5")
+print(user.rut)  # "12.345.678-5"
+```
+
+### Con Django
+
+```python
+from django.db import models
+from rut_validator.core.orm.django.schema import RUTField
+
+class Person(models.Model):
+    name = models.CharField(max_length=100)
+    rut = RUTField(unique=True)  # Validación automática en DB
+```
+
+### Con SQLAlchemy
+
+```python
+from sqlalchemy import Column, Integer, String
+from sqlalchemy.ext.declarative import declarative_base
+from rut_validator.core.orm.sqlalchemy.schema import RutSQLAlchemy
+
+Base = declarative_base()
+
+class Person(Base):
+    __tablename__ = 'persons'
+
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+    rut = Column(RutSQLAlchemy)  # Validación automática
+```
+
+## 📚 Guía Completa
+
+Lee la documentación completa en [docs/GUIA_RUT_VALIDATOR.md](docs/GUIA_RUT_VALIDATOR.md)
+
+## 🧪 Ejemplos
+
+- [Validación pura](examples/01_pure_validation.py)
+- [Uso con Pydantic](examples/02_pydantic_usage.py)
+- [Uso con FastAPI](examples/03_fastapi_usage.py)
+
+## 🔧 Desarrollo
+
+### Configuración del entorno
+
+```bash
+# Clonar repositorio
+git clone https://github.com/yourusername/rut-validator.git
+cd rut-validator
+
+# Instalar dependencias de desarrollo
+poetry install --with dev
+
+# Ejecutar tests
+poetry run pytest
+
+# Ejecutar linting
+poetry run black src/ tests/
+poetry run isort src/ tests/
+poetry run flake8 src/ tests/
+poetry run mypy src/rut_validator/
+```
+
+### Pre-commit hooks
+
+```bash
+poetry run pre-commit install
+```
+
+## 🤝 Contribuir
+
+1. Fork el proyecto
+2. Crea una rama para tu feature (`git checkout -b feature/AmazingFeature`)
+3. Commit tus cambios (`git commit -m 'Add some AmazingFeature'`)
+4. Push a la rama (`git push origin feature/AmazingFeature`)
+5. Abre un Pull Request
+
+## 📄 Licencia
+
+Este proyecto está bajo la Licencia MIT - ver el archivo [LICENSE](LICENSE) para más detalles.
+
+## 🙏 Agradecimientos
+
+- Algoritmo de validación basado en el estándar chileno del Servicio de Impuestos Internos
+- Inspirado en bibliotecas similares pero con enfoque moderno y tipado fuerte
+
+## 📞 Soporte
+
+- 🐛 [Reportar bugs](https://github.com/yourusername/rut-validator/issues)
+- 💡 [Sugerir features](https://github.com/yourusername/rut-validator/issues)
+- 📖 [Documentación](https://rut-validator.readthedocs.io/)
+

rut_validator-0.1.0/README.md

@@ -0,0 +1,173 @@
+# rut-validator
+
+[![PyPI version](https://badge.fury.io/py/rut-validator.svg)](https://pypi.org/project/rut-validator/)
+[![Python versions](https://img.shields.io/pypi/pyversions/rut-validator.svg)](https://pypi.org/project/rut-validator/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/yourusername/rut-validator/workflows/CI/badge.svg)](https://github.com/yourusername/rut-validator/actions)
+[![codecov](https://codecov.io/gh/yourusername/rut-validator/branch/main/graph/badge.svg)](https://codecov.io/gh/yourusername/rut-validator)
+[![Documentation Status](https://readthedocs.org/projects/rut-validator/badge/?version=latest)](https://rut-validator.readthedocs.io/en/latest/?badge=latest)
+
+Librería para validar RUT chileno con enfoque Pydantic-first y soporte completo para frameworks web.
+
+## ✨ Características
+
+- ✅ **Validación pura de RUT chileno** usando algoritmo módulo 11
+- ✅ **Detección automática de formato**: dotted (`12.345.678-9`), hyphenated (`12345678-9`), numeric (`123456789`)
+- ✅ **Integración completa con Pydantic** (`RutStr`)
+- ✅ **Campo Django** (`RUTField`) listo para usar
+- ✅ **Tipo SQLAlchemy** (`RutSQLAlchemy`) para bases de datos
+- ✅ **Compatible con FastAPI** y otros frameworks web
+- ✅ **Type hints completos** para mejor desarrollo
+- ✅ **Sin dependencias externas** para funcionalidad core
+- ✅ **Tests exhaustivos** con alta cobertura
+
+## 🚀 Instalación
+
+```bash
+pip install rut-validator
+
+# Con soporte Pydantic
+pip install rut-validator[pydantic]
+
+# Con soporte FastAPI
+pip install rut-validator[fastapi]
+
+# Para desarrollo
+pip install rut-validator[dev]
+```
+
+## 📖 Uso Básico
+
+### Validación Simple
+
+```python
+from rut_validator import RutValidator
+
+# Validar RUT con cualquier formato
+rut = RutValidator.validate("20.884.437-7")
+print(f"RUT válido: {rut.formatted}")  # "20.884.437-7"
+print(f"Número: {rut.number}")          # 20884437
+print(f"Dígito: {rut.digit}")          # "7"
+print(f"Formato: {rut.format}")        # RutFormat.DOTTED
+```
+
+### Detección de Formato
+
+```python
+from rut_validator import RutValidator
+
+# La librería detecta automáticamente el formato de entrada
+formats = [
+    "20.884.437-7",  # Formato dotted
+    "20884437-7",    # Formato hyphenated
+    "208844377",     # Formato numeric
+]
+
+for rut_str in formats:
+    rut = RutValidator.validate(rut_str)
+    print(f"'{rut_str}' -> Formato: {rut.format}, Es dotted: {rut.is_dotted}")
+```
+
+### Con Pydantic
+
+```python
+from pydantic import BaseModel
+from rut_validator import RutStr
+
+class User(BaseModel):
+    name: str
+    rut: RutStr  # Validación automática
+
+# Uso
+user = User(name="Juan Pérez", rut="12.345.678-5")
+print(user.rut)  # "12.345.678-5"
+```
+
+### Con Django
+
+```python
+from django.db import models
+from rut_validator.core.orm.django.schema import RUTField
+
+class Person(models.Model):
+    name = models.CharField(max_length=100)
+    rut = RUTField(unique=True)  # Validación automática en DB
+```
+
+### Con SQLAlchemy
+
+```python
+from sqlalchemy import Column, Integer, String
+from sqlalchemy.ext.declarative import declarative_base
+from rut_validator.core.orm.sqlalchemy.schema import RutSQLAlchemy
+
+Base = declarative_base()
+
+class Person(Base):
+    __tablename__ = 'persons'
+
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+    rut = Column(RutSQLAlchemy)  # Validación automática
+```
+
+## 📚 Guía Completa
+
+Lee la documentación completa en [docs/GUIA_RUT_VALIDATOR.md](docs/GUIA_RUT_VALIDATOR.md)
+
+## 🧪 Ejemplos
+
+- [Validación pura](examples/01_pure_validation.py)
+- [Uso con Pydantic](examples/02_pydantic_usage.py)
+- [Uso con FastAPI](examples/03_fastapi_usage.py)
+
+## 🔧 Desarrollo
+
+### Configuración del entorno
+
+```bash
+# Clonar repositorio
+git clone https://github.com/yourusername/rut-validator.git
+cd rut-validator
+
+# Instalar dependencias de desarrollo
+poetry install --with dev
+
+# Ejecutar tests
+poetry run pytest
+
+# Ejecutar linting
+poetry run black src/ tests/
+poetry run isort src/ tests/
+poetry run flake8 src/ tests/
+poetry run mypy src/rut_validator/
+```
+
+### Pre-commit hooks
+
+```bash
+poetry run pre-commit install
+```
+
+## 🤝 Contribuir
+
+1. Fork el proyecto
+2. Crea una rama para tu feature (`git checkout -b feature/AmazingFeature`)
+3. Commit tus cambios (`git commit -m 'Add some AmazingFeature'`)
+4. Push a la rama (`git push origin feature/AmazingFeature`)
+5. Abre un Pull Request
+
+## 📄 Licencia
+
+Este proyecto está bajo la Licencia MIT - ver el archivo [LICENSE](LICENSE) para más detalles.
+
+## 🙏 Agradecimientos
+
+- Algoritmo de validación basado en el estándar chileno del Servicio de Impuestos Internos
+- Inspirado en bibliotecas similares pero con enfoque moderno y tipado fuerte
+
+## 📞 Soporte
+
+- 🐛 [Reportar bugs](https://github.com/yourusername/rut-validator/issues)
+- 💡 [Sugerir features](https://github.com/yourusername/rut-validator/issues)
+- 📖 [Documentación](https://rut-validator.readthedocs.io/)

rut_validator-0.1.0/pyproject.toml

@@ -0,0 +1,143 @@
+[project]
+name = "rut-validator"
+version = "0.1.0"
+description = "Chilean RUT validation library with Pydantic, Django, and SQLAlchemy support"
+authors = [
+    {name = "Eli-ezer Reuven Ramirez Ruiz", email = "ramirez.ruiz.eliezer.reuven@gmail.com"}
+]
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.9,<4.0"
+keywords = ["rut", "chile", "validation", "pydantic", "django", "sqlalchemy", "fastapi"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "sqlalchemy (>=2.0.49,<3.0.0)",
+    "django (>=3.2,<5.0)",
+    "click (>=8.0.0,<9.0.0)"
+]
+
+[project.optional-dependencies]
+pydantic = ["pydantic (>=2.12.5,<3.0.0)"]
+fastapi = ["fastapi (>=0.111.0,<1.0.0)"]
+dev = [
+    "pytest (>=7.0.0)",
+    "pytest-cov",
+    "black",
+    "isort",
+    "flake8",
+    "ruff",
+    "mypy",
+    "pre-commit"
+]
+docs = [
+    "sphinx",
+    "sphinx-rtd-theme",
+    "myst-parser"
+]
+
+[project.scripts]
+rut-validator = "rut_validator.cli:cli"
+
+[project.urls]
+Homepage = "https://github.com/yourusername/rut-validator"
+Documentation = "https://rut-validator.readthedocs.io/"
+Repository = "https://github.com/yourusername/rut-validator"
+Issues = "https://github.com/yourusername/rut-validator/issues"
+Changelog = "https://github.com/yourusername/rut-validator/blob/main/CHANGELOG.md"
+
+[tool.poetry]
+packages = [{include = "rut_validator", from = "src"}]
+
+[tool.black]
+line-length = 88
+target-version = ['py39', 'py310', 'py311', 'py312', 'py313']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # directories
+  \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | build
+  | dist
+)/
+'''
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+line_length = 88
+known_first_party = ["rut_validator"]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+
+[[tool.mypy.overrides]]
+module = [
+    "pydantic.*",
+    "django.*",
+    "sqlalchemy.*",
+    "fastapi.*"
+]
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+minversion = "7.0"
+addopts = "-ra -q --strict-markers --strict-config"
+testpaths = ["tests"]
+python_files = "test_*.py"
+python_classes = "Test*"
+python_functions = "test_*"
+filterwarnings = [
+    "error",
+    "ignore::UserWarning",
+    "ignore::DeprecationWarning"
+]
+
+[tool.coverage.run]
+source = ["src/rut_validator"]
+omit = [
+    "*/tests/*",
+    "*/test_*.py",
+    "setup.py"
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError"
+]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

rut_validator-0.1.0/src/rut_validator/__init__.py

@@ -0,0 +1,26 @@
+"""
+rut-validator: Validation of Chilean RUTs for Pydantic and FastAPI
+"""
+
+from .core.validator import RutValidator
+from .core.patterns import RutFormat
+from .core.orm.pydantic.schema import RutStr
+from .errors import (
+    RutInvalidFormatError,
+    RutInvalidValueError,
+    RutModuleElevenValidationError,
+    RutValidationError,
+)
+from .types.rut import Rut as ValidatedRut
+
+__version__ = "0.1.0"
+__all__ = [
+    "RutValidator",  # For pure validation
+    "ValidatedRut",  # Validation result (alias for Rut)
+    "RutStr",  # For use with Pydantic
+    "RutFormat",  # Format enumeration
+    "RutInvalidFormatError",  # Custom exception
+    "RutInvalidValueError",  # Custom exception
+    "RutModuleElevenValidationError",  # Custom exception
+    "RutValidationError",  # Base exception
+]

rut_validator-0.1.0/src/rut_validator/constants.py

@@ -0,0 +1,3 @@
+"""Constants for RUT validation."""
+
+RUT_MODULE_ELEVEN_FACTORS = [2, 3, 4, 5, 6, 7]

rut_validator-0.1.0/src/rut_validator/core/__init__.py

@@ -0,0 +1,14 @@
+"""Core validation logic - no external dependencies"""
+
+from .formatter import RutFormatter
+from .parser import RutParser
+from .patterns import RutPatterns, RutFormat
+from .validator import RutValidator
+
+__all__ = [
+    "RutFormatter",
+    "RutParser",
+    "RutPatterns",
+    "RutFormat",
+    "RutValidator",
+]

rut_validator-0.1.0/src/rut_validator/core/formatter.py

@@ -0,0 +1,32 @@
+from rut_validator.core.patterns import RutPatterns
+
+
+class RutFormatter:
+    """Formatter for RUT strings with different output formats."""
+
+    @staticmethod
+    def to_original_format(rut: str) -> str:
+        """
+        Converts a RUT string to its original format with dots and dashes (e.g. "12345678-9" -> "12.345.678-9").
+
+        Args:
+            rut (str): The RUT string to format (e.g. "123456789")
+
+        Returns:
+            str: The RUT string in original format (e.g. "12.345.678-9")
+        """
+        return RutPatterns.formatted(rut)
+
+    @staticmethod
+    def to_normalize_format(rut: str) -> str:
+        """
+        Cleans the RUT string by removing dots and dashes, leaving only the digits and check digit.
+        This is used internally to normalize the RUT before validation.
+
+        Args:
+            rut (str): The RUT string to clean (e.g. "12.345.678-9")
+
+        Returns:
+            str: The cleaned RUT string (e.g. "123456789")
+        """
+        return RutPatterns.normalized(rut)