.. ELECU documentation master file, created by
   sphinx-quickstart on Mon Apr  1 20:14:14 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

ELECU
=====
Elections-Ecuador (ELECU) es un proyecto de código abierto basado en Python diseñado para mejorar la accesibilidad y el análisis de los resultados electorales oficiales en Ecuador. Este proyecto proporciona una biblioteca de Python para recuperar y analizar eficientemente los resultados de las elecciones de Ecuador. La información oficial es proporcionada por el Consejo Nacional Electoral del Ecuador. Este proyecto es parte del USFQ Datahub y es mantenido por Kristian Mendoza.

Descarga
--------

Los datos oficiales se encuentran disponibles en el `portal de datos abiertos del CNE <https://www.cne.gob.ec/estadisticas/bases-de-datos/>`_

Requisitos
==========

Python 3.7 o superior, compatible con Pandas, Numpy, Geopandas, Matplotlib, Seaborn, entre otros.

Instalacion
-----------

.. code-block:: bash

   pip install elecu

Uso
---

.. code-block:: python

   import elecu

Licencia del Proyecto
=====================

Este proyecto está bajo la licencia GNU_GPL3.

Licencia de los Datos
---------------------

Los datos oficiales son de dominio público. 

Ley de datos personales en Ecuador
----------------------------------

El Ecuador desde el año 2021 cuenta con una Ley de Protección de Datos Personales. Para más información revisar el `Documento <https://www.finanzaspopulares.gob.ec/wp-content/uploads/2021/07/ley_organica_de_proteccion_de_datos_personales.pdf>`_ de la ley.


Contacto
========

Para cualquier duda o comentario, por favor contactar a Kristian Mendoza o al USFQ Datahub.

Contribuciones o Dudas
======================

Para contribuir o reportar errores, por favor abrir un issue en el repositorio de GitHub.

Citacion
========

Para citar este proyecto, por favor use la siguiente referencia:

.. code-block:: none

   @misc{ELECU,
     author = {Kristian Mendoza},
     title = {ELECU},
     year = {2023},
     publisher = {GitHub},
     journal = {GitHub repository},    
   }

Agradecimientos
===============

Agradecemos a las siguientes personas por su contribución al proyecto:
Kristian Mendoza,
Pablo Medina,
Pablo Astudillo,
el USFQ Datahub,
y a todos los que han contribuido al proyecto.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`