Metadata-Version: 2.1
Name: enahodata
Version: 0.0.3
Summary: Library that automates the download of the modules of the National Household Survey (ENAHO in spanish) conducted by the National Institute of Statistics and Informatics of Peru each year.
Home-page: https://github.com/MaykolMedrano/enahodata2
Author: Maykol Medrano Cahuana & Jelsin Stalin Palomino Huaytapuma
Author-email: maykolmedrano35@gmail.com & jstpalomino@hotmail.com
License: MIT
Keywords: Perú,Peru,inei,enaho,microdatos
Classifier: Programming Language :: Python
Classifier: Operating System :: Microsoft
Classifier: Intended Audience :: Education
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: tqdm

# ENAHODATA
Esta libreria consta de un comando para extraer datos de la Encuesta Nacional de Hogares (ENAHO) del Instituto Nacional de EstadÃ­stica e InformÃ¡tica (INEI) de PerÃº que se realiza cada aÃ±o desde el 2004. Esta encuesta esta organizado por modulos.

> **Ficha tÃ©cnica**: [Consulta aquÃ­](https://proyectos.inei.gob.pe/iinei/srienaho/Descarga/FichaTecnica/498-Ficha.pdf)

Contenido
---------

- [Modulos de la encuesta (Corte transversal)](#corte-transversal)
- [Modulos de la encuesta (Datos de panel)](#datos-de-panel)
- [I. InstalaciÃ³n](#i-instalacion)
- [II. DescripciÃ³n de la librerÃ­a](#ii-descripciÃ³n-de-la-libreria)
- [III. Ejemplo](#iii-ejemplo-prÃ¡ctico)
- [IV. Como citar este repositorio](#iv-como-citar-este-repositorio)
- [Licencia](#licencia)

### Modulos de la Encuesta Nacional de Hogares (ENAHO)

Los modulos son los siguientes:

#### Corte transversal

Nro|CÃ³digo MÃ³dulo|Modulo|Preguntas
:-------|:-------|:---------|:------
1|`01`|CaracterÃ­sticas de la Vivienda y del Hogar|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=01&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=CaracterÃ­sticas+de+la+Vivienda+y+del+Hogar" target="_blank">`Preguntas`</a>
2|`02`|CaracterÃ­sticas de los Miembros del Hogar|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=02&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=CaracterÃ­sticas+de+los+Miembros+del+Hogar" target="_blank">`Preguntas`</a>
3|`03`|EducaciÃ³n|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=03&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=EducaciÃ³n" target="_blank">`Preguntas`</a>
4|`04`|Salud|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=04&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Salud" target="_blank">`Preguntas`</a>
5|`05`|Empleo e Ingresos|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=05&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Empleo+e+Ingresos" target="_blank">`Preguntas`</a>
6|`07`|	Gastos en Alimentos y Bebidas (MÃ³dulo 601)|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=07&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Gastos+en+Alimentos+y+Bebidas+(MÃ³dulo+601)" target="_blank">`Preguntas`</a>
7|`08`|Instituciones Beneficas|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=08&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Instituciones+Beneficas" target="_blank">`Preguntas`</a>
8|`09`|Mantenimiento de la Vivienda|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=09&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Mantenimiento+de+la+Vivienda" target="_blank">`Preguntas`</a>
9|`10`|Transportes y Comunicaciones|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=10&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Transportes+y+Comunicaciones" target="_blank">`Preguntas`</a>
10|`11`|Servicios a la Vivienda|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=11&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Servicios+a+la+Vivienda" target="_blank">`Preguntas`</a>
11|`12`|Esparcimiento , Diversion y Servicios de Cultura|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=12&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Esparcimiento+,+Diversion+y+Servicios+de+Cultura" target="_blank">`Preguntas`</a>
12|`13`|Vestido y Calzado|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=13&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Vestido+y+Calzado" target="_blank">`Preguntas`</a>
13|`15`|Gastos de Transferencias|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=15&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Gastos+de+Transferencias" target="_blank">`Preguntas`</a>
14|`16`|Muebles y Enseres|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=16&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Muebles+y+Enseres" target="_blank">`Preguntas`</a>
15|`17`|Otros Bienes y Servicios|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=17&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Otros+Bienes+y+Servicios" target="_blank">`Preguntas`</a>
16|`18`|Equipamiento del Hogar|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=18&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Equipamiento+del+Hogar" target="_blank">`Preguntas`</a>
17|`22`|ProducciÃ³n AgrÃ­cola|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=22&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=ProducciÃ³n+AgrÃ­cola" target="_blank">`Preguntas`</a>
18|`23`|Subproductos Agricolas|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=23&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Subproductos+Agricolas" target="_blank">`Preguntas`</a>
19|`24`|ProducciÃ³n Forestal|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=24&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=ProducciÃ³n+Forestal" target="_blank">`Preguntas`</a>
20|`25`|Gastos en Actividades Agricolas y/o Forestales|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=25&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Gastos+en+Actividades+Agricolas+y/o+Forestales" target="_blank">`Preguntas`</a>
21|`26`|ProducciÃ³n Pecuaria|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=26&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=ProducciÃ³n+Pecuaria" target="_blank">`Preguntas`</a>
22|`27`|Subproductos Pecuarios|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=27&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Subproductos+Pecuarios" target="_blank">`Preguntas`</a>
23|`28`|Gastos en Actividades Pecuarias|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=28&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Gastos+en+Actividades+Pecuarias" target="_blank">`Preguntas`</a>
24|`34`|Sumarias ( Variables Calculadas )|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=34&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Sumarias+(+Variables+Calculadas+)" target="_blank">`Preguntas`</a>
25|`37`|Programas Sociales (Miembros del Hogar)|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=37&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Programas+Sociales++(Miembros+del+Hogar)" target="_blank">`Preguntas`</a>
26|`77`|Ingresos del Trabajador Independiente|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=77&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Ingresos+del+Trabajador+Independiente" target="_blank">`Preguntas`</a>
27|`78`|Bienes y Servicios de Cuidados Personales|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=78&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Bienes+y+Servicios+de+Cuidados+Personales" target="_blank">`Preguntas`</a>
28|`84`|ParticipaciÃ³n Ciudadana|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=84&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=ParticipaciÃ³n+Ciudadana" target="_blank">`Preguntas`</a>
29|`85`|Gobernabilidad, Democracia y Transparencia|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=85&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Gobernabilidad,+Democracia+y+Transparencia" target="_blank">`Preguntas`</a>
30|`1825`|Beneficiarios de Instituciones sin fines de lucro: Olla comun|<a href="https://proyectos.inei.gob.pe/microdatos/Detalle_Encuesta.asp?CU=19558&CodEncuesta=906&CodModulo=1825&NombreEncuesta=Condiciones+de+Vida+y+Pobreza+-+ENAHO&NombreModulo=Beneficiarios+de+Instituciones+sin+fines+de+lucro:+Olla+ComÃºn" target="_blank">`Preguntas`</a>

#### Datos de panel

Nro|AÃ±o|CÃ³digo MÃ³dulo|Modulo
:-------|:-------|:-------|:---------
1|2023-2018|`1474`|CaracterÃ­sticas de la Vivienda y del Hogar
2|2023-2018|`1475`|EducaciÃ³n
3|2023-2018|`1476`|Salud
4|2023-2018|`1477`|Empleo e Ingresos
5|2023-2018|`1478`|Sumarias ( Variables Calculadas )
6|2023-2018|`1479`|CaracterÃ­sticas de los Miembros del Hogar
7|2017-2011|`01`|CaracterÃ­sticas de la Vivienda y del Hogar	
8|2017-2011|`03`|EducaciÃ³n
9|2017-2011|`04`|Salud
10|2017-2011|`05`|Empleo e Ingresos
11|2017-2011|`34`|Sumarias( Variables calculadas )
12|2017-2011|`1314`|CaracterÃ­sticas de los Miembros del Hogar
## I. Instalacion

#### Requerimientos
Para el correcto funcionamiento del paquete y sus respectivos modulos, es necesario tener instalado los siguientes paquetes adicionales:

- requests
- tqdm

#### Iniciamos la instalacion
```python
pip install enahodata
```

## II. DescripciÃ³n de la libreria 

#### 1.- Importamos la libreria

```python
from enahodata import enahodata 
import os
```

- En esta etapa importamos las librerias que se usaran, **enahodata** para extraer el comando **enahodata**.
- TambiÃ©n importamos **os** para manejar las carpetas.

#### 2.- Definimos el directorio de trabajo
```python
os.chdir("/path/to/your/directory")
```
- Usamos este cÃ³digo para definir el directorio de trabajo donde se trabajarÃ¡.

#### 3.- Definimos los paramÃ©tros del comando **_enahodata_**
El comando es enahodata, y tiene los siguientes parametros:
```python
enahodata(
    modulos: list[str]=["", "", "", ...],
    anios: list[str]=["", "", "", ...],
    descomprimir: bool = False,
    only_dta: bool = False
    overwrite: bool = False,
    output_dir: str = "NOMBRE_CARPETA",   
    panel: bool = True or False
)
```
- **modulos:** en este parÃ¡metro ponemos la lista de modulos que se quiere descargar. Se puede extraer el codigo de la columna _CÃ³digo MÃ³dulo_.
```python
enahodata(
    modulos = ["01", "02", "03",...],
    ... 
)
```

- **anios:** en este parÃ¡metro se pone la lista de aÃ±os.
```python
enahodata(
    ...
    anios = ["2020", "2021", "2022",...]
    ...
)
```
- **descomprimir:** con esta opciÃ³n se selecciona _True_ o _False_ para que se descomprima o no, respectivamente.
```python
enahodata(
    ...
    descomprimir:bool = ...,
    ...
)
```
- **only_data:** con este parametro del comando seleccionamos si se enfocara solo en los archivos _.dta_ o no. Tiene dos valores _True_ o _False_.
```python
enahodata(
    ...
    only_dta: bool = ...,
    ...
)
```
- **overwrite:** con esta opciÃ³n se indica si se reemplaza los archivos ya existentes o no. Tiene dos valores _True_ o _False_.
```python
enahodata(
    ...
    overwrite: bool = ...,
    ...
)
```
- **output_dir:** con este parÃ¡metro se indica el nombre que tendra la carpeta donde se almacenaran los archivos de los modulos descargados de la ENAHO. 
```python
enahodata(
    ...
    output_dir: str = "NOMBRE_CARPETA",   
)
```

- **panel:** con este parÃ¡metro se indica si se descargarÃ¡ los datasets de corte transversal o los de panel data. Tiene dos valores _True_ (datos de panel) y _False_ (corte transversal). 
```python
enahodata(
    ...
    panel: bool = ...,   
)
```


#### 4.- Plantilla completa

```python
from enahodata import enahodata 
import os

os.chdir("/path/to/your/directory")

enahodata(
    modulos = ["01", "02", "03",...],,
    anios = list[str],
    descomprimir = ...,
    only_dta = ...,
    overwrite = ...,
    output_dir = "NOMBRE_CARPETA",   
    panel = ...,
)

```

## III. Ejemplo prÃ¡ctico

Se necesita descargar de los aÃ±os 2022 y 2023, los siguientes mÃ³dulos de la Encuesta Nacional de Hogares de PerÃº:
- CaracterÃ­sticas de la Vivienda y del Hogar
- EducaciÃ³n 
- Salud

Entonces, con la informaciÃ³n anterior revisamos el codigo de cada modulo. En este caso los codigos son los siguientes:
- `01` : CaracterÃ­sticas de la vivienda y del hogar
- `03` : EducaciÃ³n
- `04` : Salud

Luego, realizamos lo siguiente:
```python
pip install enahodata
```
En otro archivo `ejemplo.py`, por ejemplo escribimos el siguiente cÃ³digo:
```python
from enahodata import enahodata
import os

os.chdir("C:\Users\Usuario\Desktop\ejemplo")

enahodata(
  modulos=["01","03","04"],
  anios=["2022", "2023"],
  descomprimir=True,
  only_dta=True,
  overwrite=True, 
  output_dir="datos_ENAHO",
  panel=False 
)

```
Ejecutamos el codigo:
```python
python ejemplo.py
```
![enahodata](./img/resultados.PNG)

Y se creara la siguiente estructura de carpetas, como resultado:

<img src="./img/tree.PNG" width="210" height="">

Donde:
- **/modulo_01_2022_dta_only** 
- **/modulo_01_2023_dta_only** 
- **/modulo_03_2022_dta_only** 
- **/modulo_03_2023_dta_only** 
- **/modulo_04_2022_dta_only** 
- **/modulo_04_2023_dta_only** 
>Son las carpetas donde se encuentran los dataset en formato `.dta`

- **/modulo_01_2022_extract** 
- **/modulo_01_2023_extract** 
- **/modulo_03_2022_extract** 
- **/modulo_03_2023_extract** 
- **/modulo_04_2022_extract** 
- **/modulo_04_2023_extract** 

>En estas carpetas se encuentran, la informaciÃ³n descomprimida de la ENAHO, con toda la informaciÃ³n que viene desde el portal de microdatos del INEI.

### Nota
- Cuando se active la opciÃ³n `panel=True`, tener en cuenta que los datasets tienen un peso considerable. El proceso sera el mismo, la diferencia se encuentra en el tamaÃ±o de los archivos que se descarÃ¡n.
- Otro aspecto a tener en cuenta, los cÃ³digos a usar para la funciÃ³n debe ser los que pertenecen a la tabla de datos de panel, considerando el periodo de tiempo que son vigentes los codigos a usar.

## IV. Como citar este repositorio
```plaintext
Medrano M. & Palomino J. (2025). ENAHODATA (versiÃ³n Python) [Software]. GitHub. (https://github.com/MaykolMedrano/enahodata_py)
```

## Licencia

Este repositorio esta autorizado bajo la licencia MIT. Ver <a href="./LICENSE">LICENCIA</a> para mas detalles.
