Metadata-Version: 2.1
Name: pymorant
Version: 0.0.34
Summary: Paquetería de funciones para el equipo de AI Morant en Python
Home-page: https://github.com/morant-consultores/py_morant
Author: Equipo AI Morant
Author-email: abravo@morant.com.mx
Project-URL: Bug Tracker, https://github.com/morant-consultores/py_morant/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp ==3.8.5
Requires-Dist: aiosignal ==1.3.1
Requires-Dist: annotated-types ==0.5.0
Requires-Dist: async-timeout ==4.0.3
Requires-Dist: attrs ==23.1.0
Requires-Dist: certifi ==2023.7.22
Requires-Dist: charset-normalizer ==3.2.0
Requires-Dist: dataclasses-json ==0.5.14
Requires-Dist: frozenlist ==1.4.0
Requires-Dist: idna ==3.4
Requires-Dist: langchain ==0.0.268
Requires-Dist: langsmith ==0.0.24
Requires-Dist: marshmallow ==3.20.1
Requires-Dist: multidict ==6.0.4
Requires-Dist: mypy-extensions ==1.0.0
Requires-Dist: numexpr ==2.8.5
Requires-Dist: numpy ==1.25.2
Requires-Dist: openai ==0.27.8
Requires-Dist: packaging ==23.1
Requires-Dist: pydantic ==2.2.1
Requires-Dist: pydantic-core ==2.6.1
Requires-Dist: PyYAML ==6.0.1
Requires-Dist: regex ==2023.8.8
Requires-Dist: requests ==2.31.0
Requires-Dist: SQLAlchemy ==2.0.20
Requires-Dist: tenacity ==8.2.3
Requires-Dist: tiktoken ==0.4.0
Requires-Dist: tqdm ==4.66.1
Requires-Dist: typing-inspect ==0.9.0
Requires-Dist: typing-extensions ==4.7.1
Requires-Dist: urllib3 ==2.0.4
Requires-Dist: yarl ==1.9.2

# Py-morant

Este proyecto incluye varias funciones útiles que desempeñan diferentes tareas.

## Instalación

Para instalar la paquetería pymorant en tu terminal escribe. 
```
pip install pymorant
```
Es recomendado usar un [ambiente virtual](https://docs.python.org/3/library/venv.html).

## Funciones

### 1. corregir_texto
```py
from pymorant import corregir_texto
```

Regresa el texto corregido ortográficamente, utilizando el modelo de lenguaje especificado.

**Parámetros**
- text (str): texto original
- model (str): modelo de lenguaje a utilizar
- openai_key (str): llave de OpenAI

**Retorna**
- cleaned_text (str): texto limpio

### 2. generar_variantes_texto
```py
from pymorant import generar_variantes_texto
```

Regresa una lista de n variantes del texto original, utilizando el modelo de lenguaje especificado. Si formal=True, se generan variantes formales.

**Parámetros**
- text (str): texto original
- n (int): número de variantes a generar
- model (str): modelo de lenguaje a utilizar
- openai_key (str): llave de OpenAI
- formal (bool): si True, se generan variantes formales
- sex: sexo de la persona a la que se dirige el texto. Puede ser "H" (hombre), "M" (mujer) o "NA" (no aplica).

**Retorna**
- lista (list): lista con n variaciones del texto original

### 3. resumir_texto
```py
from pymorant import resumir_texto
```

Regresa un resumen del texto original, utilizando el modelo de lenguaje especificado.

**Parámetros**
- text (str): texto original
- model (str): modelo de lenguaje a utilizar
- openai_key (str): llave de OpenAI
- input_autogenerado (bool): si True, si el input es auto-generado por el modelo previamente.

**Retorna**
- texto (str): resumen del texto original

### 4. generar_categorias
```py
from pymorant import generar_categorias
```

Regresa una lista de n categorías del texto original, utilizando el modelo de lenguaje. especificado.

**Parámetros**
- text (str): texto original
- n (int): número de categorías a generar
- model (str): modelo de lenguaje a utilizar
- openai_key (str): llave de OpenAI

**Retorna**
- lista (list): lista de n categorias del texto original


## License
MIT
