Merge branch 'feat/05_reports' into feat/06_main

Author: Esteban Echeverry

.gitignore

@@ -101,4 +101,4 @@ ENV/
 .mypy_cache/
 
 # vscode
-.vscode
+.vscode/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = CleanArchitecturePython
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,169 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Clean Architecture Python documentation build configuration file, created by
+# sphinx-quickstart on Thu Feb  8 19:00:03 2018.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.todo', 'sphinx.ext.graphviz']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Clean Architecture Python'
+copyright = '2018, Nubark'
+author = 'Nubark'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'es'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'CleanArchitecturePythondoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'CleanArchitecturePython.tex', 'Clean Architecture Python Documentation',
+     'Nubark', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'cleanarchitecturepython', 'Clean Architecture Python Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'CleanArchitecturePython', 'Clean Architecture Python Documentation',
+     author, 'CleanArchitecturePython', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/fundamentos/index.md

@@ -0,0 +1,46 @@
+Fundamentos
+###########
+
+Podría decirse que *Clean Architecture* no inventa nada nuevo, sino que agrupa
+metodologías, principios y patrones de diseño conocidos en la industria del
+software desde hace décadas. Sin embargo, lo que *Clean Architecture* sí trae
+a la mesa es su objetivo: crear aplicaciones flexibles que sean fáciles de
+mantener en el tiempo.
+
+SOLID
+*****
+
+- S-ingle Responsability Principle
+
+Cada componente del sistema debería tener una única reponsabilidad.
+
+- O-pen/Closed Principle
+
+Abierto para extensión, cerrado para modificación.
+
+- L-iskov Substitution Principle
+
+- I-nterface Segregation Principle
+
+- D-ependency Inversion Principle
+
+Tipos de Programación
+*********************
+
+- Programación Estructurada
+
+Secuencia y selección e iteración. (def, if, while, for)
+
+- Programación Orientada a Objetos
+
+Clases, Objetos, Herencia.
+
+- Programación Funcional
+
+Funciones. No se persiste el estado.
+
+Modelado del Dominio
+********************
+
+El núcleo de una aplicación es el dominio que tiene como propósito modelar.
+Este dominio se representa a través de lo que llamamos, la lógica de negocio.

docs/fundamentos/index.rst

@@ -0,0 +1,51 @@
+Implementación
+##############
+
+
+!Arquitectura que Grita!
+************************
+
+El propósito de nuestras aplicaciones debe hacerse notar de primera mano.
+
+La Regla de las Dependencias
+****************************
+
+Las dependencias de una aplicación deben dirigirse en la vía de mayor
+abstracción.
+
+Capas y Fronteras
+*****************
+
+Los componentes de una aplicación se comunican entre sí a través de fronteras
+bien definidas.
+
+Los Detalles
+************
+
+Las consideraciones de infraestructura son sólo *detalles* del sistema.
+La base de datos, el framework web, las librerías de consola, son sólo
+herramientas de nuestras aplicaciones y no su esencia.
+
+```
+For the framework author, coupling to his or her own framework is not a risk...
+
+The author wants you to couple to the framework, because once coupled in this
+way, it is very hard to break away.
+```
+
+El Componente Principal
+***********************
+
+El más sucio de los componentes. Es el encargado de instanciar el arbol de
+dependencias para crear la aplicación final.
+
+Las Pruebas
+***********
+
+Las pruebas o *tests* son el componente más externo de nuestra aplicación. A
+pesar de que no pueden asegurar que nuestras aplicaciones son correctas, si
+pueden informarnos que *no son incorrectas* y prevenir regresiones durante el
+desarrollo.
+
+.. todo::
+   agregar imagen de un escalador con su arnés

docs/implementacion/index.md

@@ -0,0 +1,20 @@
+.. Clean Architecture Python documentation master file, created by
+   sphinx-quickstart on Thu Feb  8 19:00:03 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Clean Architecture con Python
+#############################
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contenido:
+
+   introduccion/index.rst
+   fundamentos/index.rst
+   implementacion/index.rst
+   proyecto/index.rst
+   sobre/index.rst
+
+
+

docs/implementacion/index.rst

@@ -0,0 +1,28 @@
+¿Qué es Clean Architecture?
+###########################
+
+Clean Architecture o arquitectura limpia, es un compendio de principios y 
+patrones de desarrollo que tienen como objetivo el facilitar el proceso de
+construcción del software, así como su mantenimiento.
+
+.. todo::
+   Agregar imágen introductoria
+
+Entre sus principales beneficios podemos encontrar:
+
+Beneficios
+**********
+
+- Creación de aplicaciones desacopladas que son más fáciles de probar
+- Mayor flexibilidad para añadir o remover funcionalidades del software
+- Diseño basado en componentes con responsabilidades bien definidas
+- Aplazamiento de decisiones críticas hasta el último momento requerido
+
+
+Usos
+****
+
+- Aplicaciones de negocios proyectadas para estar en operación indefinidamente.
+- Sistemas distribuidos que se beneficien de un diseño desacoplado (e.g. usando
+microservicios).
+- Infraestructuras heterogeneas a nivel de bases de datos, servicios web, etc.