Definir la constitución del proyecto y su forma de ejecución

Author: Esteban Echeverry

docs/proyecto/descripcion.rst

@@ -4,41 +4,34 @@ Descripción
 Realizaremos una aplicación para gestionar nuestras tareas por realizar.
 En general, la estructura de la aplicación estará compuesta por:
 
-- **Tarea** (task): Unidad básica de gestión del trabajo cuyos atributos serán:
-  - UID (uid: str)
-  - Nombre (name: str)
-  - Fecha Límite (due_date: datetime)
-  - Prioridad (priority: int)
-  - ID Proyecto (project_id: str)
-  - ID Etapa (stage_id: str)
-  - Comentarios (comments: str)
-
-- **Proyecto** (project): Contenedor de tareas con un mismo propósito cuyos atributos serán:
-  - UID (uid: str)
-  - Nombre (name: str)
-  - Etapas (stage_ids: List[str])
-  - Comentarios (comments: str)
-
-- **Etapa** (stage): Estado en el que puede estar cada tarea. Un proyecto tiene múltiples etapas. Sus atributos son:
-  - UID (uid: str)
-  - Nombre (name: str)
-  - Cierre (closure: bool)
+`Taskit Repo <https://github.com/nubark/clean-architecture-python.git>`_
+
+|  - **Tarea** (task): Unidad básica de gestión del trabajo cuyos atributos serán:
+|    UID (uid: str)
+|    Nombre (name: str)
+|    Fecha Límite (due_date: datetime)
+|    Prioridad (priority: int)
+|    ID Proyecto (project_id: str)
+|    Etapa (stage: str)
+|    Comentarios (comments: str)
+
+|  - **Proyecto** (project): Contenedor de tareas con un mismo propósito cuyos
+   atributos serán:
+|    UID (uid: str)
+|    Nombre (name: str)
+|    Comentarios (comments: str)
 
 La aplicación nos permitirá:
 
-- Crear, leer, modificar y eliminar nuevas tareas, proyectos y etapas.
+- Crear, leer, modificar y eliminar nuevas tareas y proyectos.
 - Asignar tareas a proyectos específicos.
-- Definir la prioridad y fecha límite de cada tarea.
-- Mover las tareas por las distintas etapas del proyecto hasta el estado de cierre.
+- Mover las tareas por las distintas etapas del proyecto hasta el
+  estado de cierre.
 
-Igualmente, implementaremos algunas restricciones:
+Obtendremos información valiosa para analizar detalladamente
+nuestro trabajo pudiendo:
 
-- Un proyecto sólo podrá tener una etapa de cierre.
-- No se podrán eliminar tareas en estado de cierre.
-- Habrá un proyecto, entre todos, que se usará por defecto cuando no se especifique alguno en las tareas.
-
-Finalmente, obtendremos información valiosa para analizar detalladamente nuestro trabajo pudiendo:
-
-- Reportar las tareas con fecha límite igual o inferior al día actual, los próximos 7 días, etc.
-- Reportar las tareas que se encuentran en un mismo proyecto.
-- Reportar las tareas que se encuentran en una misma etapa (a través de todos los proyectos).
+- Reportar todas las tareas registradas.
+- Reportar todos los proyectos registrados.
+- Reportar todas las tareas pertenecientes a un mismo proyecto.
+- Reportar todas las tareas con la misma etapa.

docs/proyecto/ejecución.rst

@@ -0,0 +1,48 @@
+Ejecución
+*********
+
+El repositorio contiene 6 ramas de desarrollo incremental:
+
+- feat/01_models
+- feat/02_repositories
+- feat/03_coordinators
+- feat/04_infrastructure
+- feat/05_reports
+- feat/06_main
+
+Cada una de ellas construye una capa o componente de la aplicación. En el
+proceso de recrear esta construcción, usaremos un enfoque de desarrollo
+guiado por pruebas (i.e. *TDD*). Esto asegurará que los componentes que
+diseñemos, se encuentren desacoplados desde el inicio y sean fáciles de
+extender.
+
+Todos iniciarán en la rama *feat/docs* la cuál no contiene código. En el
+proyector se presentará el *estado* o rama objetivo. En la primera iteración
+esta rama será la *feat/01_models*. En la segunda iteración, cuando hayamos
+alcanzado el estado de la rama *feat/01_models*, la rama objetivo será la
+*feat/02_repositories*. Así lo haremos sucesivamente hasta completar la 
+aplicación.
+
+Dedicaremos un tiempo máximo de 15 minutos a cada fase. Si al completarse los
+15 minutos no se ha terminado la totalidad de la funcionalidad requerida,
+lamentablemente tendremos que ejecutar **git reset --hard**. Por supuesto,
+pueden guardar sus cambios en una rama temporal si quieren (e.g. my/01_models).
+La idea es contar con el tiempo suficiente para abordar la totalidad de la
+aplicación. No se preocupen, tendrán tiempo de sobra para seguir el paso a
+paso en la comodidad de sus casas ;D
+
+Comandos Importantes
+====================
+
+- Correr los tests con pytest:
+
+    pytest -s --cov-report term-missing --cov-branch --cov taskit tests
+
+- Empaquetar nuestra 
+
+    pyinstaller -F taskit/__main__.py -n taskit
+
+Finalmente
+==========
+
+**¡Manos a la obra!**

docs/proyecto/index.rst

@@ -9,5 +9,6 @@ Proyecto *Taskit*
 
    descripcion.rst
    preparacion.rst
+   ejecución.rst
 
 

docs/proyecto/preparacion.rst

@@ -1,2 +1,8 @@
 Preparación
-***********
+***********
+
+- Asegurarse de tener instalado **Python 3.5+**
+- Clonar el repositorio del proyecto: **git clone https://github.com/nubark/clean-architecture-python.git**
+- Crear un nuevo **virtual environment** (e.g. clean-architecture-python)
+- Instalar las dependencias del proyecto: **pip install -r requirements.txt**
+- Hacer checkout a la rama *feat/docs*: **git checkout feat/docs**