Project-Example-2

Project-Example-2

One liner que dice qué es el proyecto

Acá se escribe un párrafo o dos que describan un poco más el proyecto. Debe ser breve pero lo suficientemente explicativo para que el usuario entienda para qué sirve este proyecto, qué tipo de data toma y qué tipo de output o aplicación genera.

Table of Contents generated with DocToc

• One liner que dice qué es el proyecto
  • Ejemplo
  • Instalación
  • Tests
  • Convenciones de estilo

Ejemplo

En esta sección se muestra cómo usar el paquete con un ejemplo sencillo.

import package_name
fib = package_name.fibonacci(20)
print fib

Instalación

En esta sección se listan los pasos necesarios para instalar el paquete.

• Instalar Python 2.7 (se recomienda instalar Anaconda)
• brew install dependencia_para_mac (instala primero cualquier dependencia necesaria)
• conda create -n my_environment python=2 (crea un entorno virtual -copia limpia de python- donde instalar el proyecto con Anaconda)
• source activate my_environment (activa el entorno virtual)
• pip install -e . (instala el proyecto en modo edición: los packages listados en el setup.py se instalan en el path del entorno virtual de manera que permiten importaciones absolutas)
• deactivate (desactiva el entorno virtual)

Alternativamente, si no se utiliza Anaconda se puede usar virtualenv para crear entornos virtuales:

• cd my_project
• virtualenv venv
• source venv/bin/activate
• pip install -e .
• deactivate

Tests

En esta sección se muestra como correr los tests.

• nosetests (corre todos los tests)

Convenciones de estilo

Este proyecto sigue las convenciones de la Google Python Style Guide.

Ver un ejemplo completo del uso de docstrings en python según la guía de Google