o Starting on some code for building reports from the project.

16 files changed, 382 insertions, 10 deletions

diff --git a/demo/doit/docs/.gitignore b/demo/doit/docs/.gitignore
new file mode 100644
index 0000000..e35d885
--- /dev/null
+++ b/demo/doit/docs/.gitignore
@@ -0,0 +1 @@
+_build
diff --git a/demo/doit/docs/Makefile b/demo/doit/docs/Makefile
new file mode 100644
index 0000000..a7ef341
--- /dev/null
+++ b/demo/doit/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    = Demo
+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)
\ No newline at end of file
diff --git a/demo/doit/docs/conf.py b/demo/doit/docs/conf.py
new file mode 100644
index 0000000..4c45eca
--- /dev/null
+++ b/demo/doit/docs/conf.py
@@ -0,0 +1,155 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Demo'
+copyright = '2018, Demo'
+author = 'Demo'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- 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 = [
+]
+
+# 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'
+
+# 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 = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects 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'
+
+
+# -- 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 = 'alabaster'
+
+# 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.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Demodoc'
+
+
+# -- 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, 'Demo.tex', 'Demo Documentation',
+     'Demo', '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, 'demo', 'Demo 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, 'Demo', 'Demo Documentation',
+     author, 'Demo', 'One line description of project.',
+     'Miscellaneous'),
+]
\ No newline at end of file
diff --git a/demo/doit/docs/index.rst b/demo/doit/docs/index.rst
new file mode 100644
index 0000000..437a1e5
--- /dev/null
+++ b/demo/doit/docs/index.rst
@@ -0,0 +1,24 @@
+.. Demo documentation master file, created by
+   sphinx-quickstart on Sun Aug  5 12:49:19 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Demo's documentation!
+================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   :numbered:
+
+   report/index
+   report/messages
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/demo/doit/docs/make.bat b/demo/doit/docs/make.bat
new file mode 100644
index 0000000..f8072c5
--- /dev/null
+++ b/demo/doit/docs/make.bat
@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=Demo
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/demo/doit/docs/report/index.rst b/demo/doit/docs/report/index.rst
new file mode 100644
index 0000000..98b460a
--- /dev/null
+++ b/demo/doit/docs/report/index.rst
@@ -0,0 +1,4 @@
+Reports
+-------
+
+* :doc:`messages`
diff --git a/demo/doit/docs/report/messages.rst b/demo/doit/docs/report/messages.rst
new file mode 100644
index 0000000..d2c6bd2
--- /dev/null
+++ b/demo/doit/docs/report/messages.rst
@@ -0,0 +1,5 @@
+Messages
+--------
+
+There are 0 messages.
+
diff --git a/demo/doit/dodo.py b/demo/doit/dodo.py
index 780f2b9..74b621b 100644
--- a/demo/doit/dodo.py
+++ b/demo/doit/dodo.py
@@ -1,8 +1,10 @@
 from ee.bom.doit import *
 from ee.digikey.doit import *
-from ee.doit import configure_logging
+from ee.doit import configure_logging, ReportCollection
 from ee.ds import DataSetManager
 from ee.kicad.doit import *
+# noinspection PyUnresolvedReferences
+from ee.report.doit import *
 
 
 def configure_kicad():
@@ -22,6 +24,11 @@ def configure_digikey():
     doit_config.configure(data_set_manager=dsm)
 
 
+def configure_report():
+    from ee.report.doit import doit_config
+    doit_config.configure(data_set_manager=dsm, report_collection=report_collection, extra_config=extra_config)
+
+
 # Configure DoIt
 configure_logging()
 
@@ -31,7 +38,10 @@ prj = "demo"
 sch = "{}.sch".format(prj)
 kicad_pcb = "{}.kicad_pcb".format(prj)
 
+extra_config = dict(report_dir="docs/report")
+
 dsm = DataSetManager("ee")
+report_collection = ReportCollection()
 
 kicad_footprint = "kicad-footprint"
 dsm.register_ds("csv", kicad_footprint, "kicad-footprint-mapping", path="ee/kicad-footprint.csv")
@@ -39,6 +49,7 @@ dsm.register_ds("csv", kicad_footprint, "kicad-footprint-mapping", path="ee/kica
 configure_kicad()
 configure_bom()
 configure_digikey()
+configure_report()
 
 
 def task_orders():
diff --git a/requirements.txt b/requirements.txt
index 7bcc478..bf89db3 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,9 +1,10 @@
 # for development, see setup.py for production dependencies.
 ansicolors==1.1.8
-CacheControl==0.12.5
+cachecontrol==0.12.5
 configclass==0.1.0
 lockfile==0.12.2
 lxml==4.2.3
+jinja2==2.10
 matplotlib==2.2.2
 mpmath==1.0.0
 namedlist==1.7
@@ -13,7 +14,6 @@ parsec==3.3
 Pillow==5.2.0
 pytest==3.6.3
 requests==2.19.1
-sympy==1.2
 tox==3.1.2
 
 # for development
diff --git a/setup.py b/setup.py
index 0abc8d4..0a1801a 100644
--- a/setup.py
+++ b/setup.py
@@ -15,6 +15,7 @@ setup(name='ee',
           'configclass',
           'lockfile',
           'lxml',
+          'jinja2',
           'matplotlib',
           'mpmath',
           'namedlist',
@@ -25,6 +26,5 @@ setup(name='ee',
           'pytest',
           'pyyaml',
           'requests',
-          'sympy',
       ],
       )
diff --git a/src/ee/doit.py b/src/ee/doit.py
index a89fdf7..665f039 100644
--- a/src/ee/doit.py
+++ b/src/ee/doit.py
@@ -1,9 +1,12 @@
 import logging
+from typing import Tuple, List, Mapping, Any
 
 from doit import get_var
 
 from ee.ds import DataSetManager
 
+logger = logging.getLogger(__name__)
+
 
 def configure_logging():
     log_level = get_var("log-level", None)
@@ -18,20 +21,55 @@ def configure_logging():
         ee_logger.setLevel(log_level)
 
 
+class Report(object):
+    def __init__(self, task):
+        self.task = task
+
+
+class ReportCollection(object):
+    def __init__(self):
+        self._reports = []  # type: List[Report]
+
+    def add_report(self, report: Report):
+        self._reports.append(report)
+
+    @property
+    def reports(self) -> Tuple[Report]:
+        return tuple(self._reports)
+
+
+# This should probably be called "DoItModuleConfig" since it is used once per module. The module is responsible for
+# instantiating it.
 class DoItConfig(object):
     def __init__(self):
         self._dsm = None  # type: DataSetManager
+        self._report_collection = None  # type: ReportCollection
+        self._extra_config = None  # type: Mapping[str, Any]
         self._data_sets = {}
+        self._reports = []
 
-    def configure(self, *, data_set_manager: DataSetManager):
+    def configure(self, *, data_set_manager: DataSetManager, report_collection: ReportCollection = None,
+                  extra_config: Mapping[str, Any] = None):
         self._dsm = data_set_manager
+        self._report_collection = report_collection if report_collection is not None else {}
+        self._extra_config = extra_config
 
     @property
-    def dsm(self):
-        if not self._dsm:
-            raise Exception("The DataSetManager has not been set")
+    def dsm(self) -> DataSetManager:
+        if self._dsm is None:
+            raise Exception("The data set manager has not been set")
         return self._dsm
 
+    @property
+    def report_collection(self):
+        if self._report_collection is None:
+            raise Exception("The report collection has not been set")
+        return self._report_collection
+
+    @property
+    def extra_config(self):
+        return self._extra_config
+
     def data_sets_for(self, task):
         try:
             return self._data_sets[task]
diff --git a/src/ee/ds/__init__.py b/src/ee/ds/__init__.py
index e543051..915dd6f 100644
--- a/src/ee/ds/__init__.py
+++ b/src/ee/ds/__init__.py
@@ -270,6 +270,11 @@ class DataSetManager(object):
         self._basedir = Path(basedir)
         self._csv = {}  # type: MutableMapping[str, Tuple[str, Path]]
 
+    @property
+    def all_data_sets(self):
+        datasets = [ds.name for ds in self._basedir.iterdir() if (ds / "data-set.ini").is_file()]
+        return list(self._csv.keys()) + datasets
+
     def cookie_for_ds(self, ds_name) -> Path:
         try:
             return self._csv[ds_name][1]
@@ -314,7 +319,7 @@ class DataSetManager(object):
 
     @staticmethod
     def _load_csv(object_type: str, path: Path, freeze: bool) -> DataSet:
-        logger.debug("Loading CSV file {}".format(path))
+        # logger.debug("Loading CSV file {}".format(path))
         ds = DataSet()
 
         with open(str(path), newline='') as f:
@@ -334,7 +339,7 @@ class DataSetManager(object):
         if freeze:
             ds.freeze()
 
-        logger.debug("Loaded {} objects".format(len(ds)))
+        # logger.debug("Loaded {} objects".format(len(ds)))
         return ds
 
     def _load_ini_dir(self, _path: str, freeze: bool) -> DataSet:
diff --git a/src/ee/report/__init__.py b/src/ee/report/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/src/ee/report/__init__.py
diff --git a/src/ee/report/doit.py b/src/ee/report/doit.py
new file mode 100644
index 0000000..5d28ed4
--- /dev/null
+++ b/src/ee/report/doit.py
@@ -0,0 +1,61 @@
+import logging
+from pathlib import Path
+
+from jinja2 import Environment, PackageLoader, select_autoescape
+
+from ee.doit import DoItConfig, Report
+
+logger = logging.getLogger(__name__)
+
+doit_config = DoItConfig()
+
+
+def _create_env():
+    return Environment(
+        loader=PackageLoader("ee.report.doit", "templates"),
+        autoescape=select_autoescape(["html", "xml"])
+    )
+
+
+def task_report_messages():
+    doit_config.report_collection.add_report(Report(task_report_messages))
+
+    def action():
+        logger.debug("Generating messages report")
+
+        data_sets = doit_config.dsm.all_data_sets
+
+        logger.debug("Loading {} data sets".format(len(data_sets)))
+
+        ds = doit_config.dsm.load_data_sets(data_sets)
+
+        messages = [o for o in ds.items() if o.object_type.name == "message"]
+        logger.debug("Found {} messages".format(len(messages)))
+
+        report_dir = Path(doit_config.extra_config["report_dir"])
+        report_dir.mkdir(exist_ok=True)
+
+        with open(report_dir / "messages.rst", "w") as f:
+            env = _create_env()
+            template = env.get_template("messages.rst.j2")
+            f.write(template.render(messages=messages))
+
+    return {
+        "actions": [action]
+    }
+
+
+def task_make_reports():
+    def action():
+        report_dir = Path(doit_config.extra_config["report_dir"])
+        report_dir.mkdir(exist_ok=True)
+
+        with open(report_dir / "index.rst", "w") as f:
+            env = _create_env()
+            template = env.get_template("index.rst.j2")
+            f.write(template.render())
+
+    return {
+        "actions": [action],
+        "task_dep": [r.task.__name__[5:] for r in doit_config.report_collection.reports]
+    }
diff --git a/src/ee/report/templates/index.rst.j2 b/src/ee/report/templates/index.rst.j2
new file mode 100644
index 0000000..5eaf939
--- /dev/null
+++ b/src/ee/report/templates/index.rst.j2
@@ -0,0 +1,4 @@
+Reports
+=======
+
+* :doc:`messages`
diff --git a/src/ee/report/templates/messages.rst.j2 b/src/ee/report/templates/messages.rst.j2
new file mode 100644
index 0000000..ca08c04
--- /dev/null
+++ b/src/ee/report/templates/messages.rst.j2
@@ -0,0 +1,8 @@
+Messages
+========
+
+There are {{ messages|count }} messages.
+
+{% for m in messages %}
+    Message: {{ m.level }}
+{% endfor %}