Skip to content

README.md

Latest commit

 

History

History
123 lines (94 loc) · 3.03 KB

README.md

File metadata and controls

123 lines (94 loc) · 3.03 KB
Raw

Data Analysis Template Python Poetry

Template base para proyectos de análisis de datos en Python, utilizando Poetry como gestor de dependencias y entorno virtual.

🧰 Características

  • Gestión de entorno y dependencias con Poetry
  • Estructura modular organizada por carpetas
  • Preparado para notebooks, scripts, y modelos de base de datos
  • Listo para entornos colaborativos y control de versiones

⚙️ Requisitos

🚀 Instalación rápida

  1. Clona el repositorio:
https://github.com/SantiRendon/data-analysis-template-python-poetry.git
  1. Navega al directorio del proyecto:
cd data-analysis-template-python-poetry
  1. Instala las dependencias del proyecto con Poetry:
poetry install

📦 Dependencias incluidas

Este template incluye paquetes esenciales para análisis de datos en Python:

  • pandas: Manipulación y análisis de datos tabulares con estructuras como DataFrame.
  • numpy: Computación numérica eficiente con arrays multidimensionales.
  • matplotlib: Visualización básica de datos en gráficos estáticos.
  • seaborn: Visualización estadística avanzada sobre matplotlib, con estilo mejorado.
  • jupyter: Herramientas para ejecutar notebooks interactivos desde el navegador.
  • ipykernel: Permite usar entornos de Poetry como kernel en Jupyter.
  • mysql-connector-python: Conector oficial de MySQL para conectarse a bases de datos desde Python.

📦 Uso de Poetry

Personalizar el proyecto

Edita el archivo pyproject.toml para ajustar los metadatos del proyecto:

  • name: nombre del proyecto
  • version: versión inicial
  • description: breve descripción
  • authors: tu nombre y correo

Ejemplo:

[tool.poetry]
name = "mi-analisis-datos"
version = "0.1.0"
description = "Análisis exploratorio del consumo de energía en Latinoamérica"
authors = [
    {name = "santiDev",email = "xantirendonc@gmail.com"}
]

Agregar una nueva dependencia

poetry add nombre_paquete

Ejemplo:

poetry add pandas matplotlib jupyterlab

Instalar todas las dependencias del proyecto (incluyendo las de desarrollo)

poetry install --with dev

🗂️ Estructura del Proyecto

📁 data-analysis-template-python-poetry
│
├── 📁data
│   ├── 📁external
│   ├── 📁processed
│   ├── 📁raw
│   └── 📁tables
│
├── 📁database
│   ├── 📁models
│   ├── 📁queries
│   └── 📁scripts
│
├── 📁docs
│   ├── 📁diagrams
│   ├── 📁planning
│   └── 📁research
│
├── 📁notebooks
├── 📁reports
│   └── 📁figures
├── 📁src
│   └── 📁scripts
│
├── .gitignore
├── LICENSE
├── README.md
└── pyproject.toml

📜 Licencia

Este proyecto está bajo la licencia MIT.