Merge branch 'develop'

Author: kupferk

CHANGELOG.md

@@ -1,3 +1,13 @@
+# Version 0.13.0 - 2020-04-21
+
+* Refactor Maven module structure
+* Implement new Scala DSL for creating projects
+* Fix ordering bug in target execution
+* Merge 'migrate' phase into 'create' phase
+* Rename 'input' field to 'mapping' in most targets
+* Lots of minor code improvements
+
+
 # Version 0.12.2 - 2020-04-06
 
 * Fix type coercion of DecimalTypes

docker/pom.xml

@@ -10,7 +10,7 @@
     <parent>
         <groupId>com.dimajix.flowman</groupId>
         <artifactId>flowman-root</artifactId>
-        <version>0.12.2</version>
+        <version>0.13.0</version>
         <relativePath>..</relativePath>
     </parent>
 

docs/.gitignore

@@ -1 +1,2 @@
 _site
+_build

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    = Flowman
+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/_config.yml

@@ -1,4 +1,49 @@
-# Flowman Execution Tool (flowexec)
+# Flowman Executor (flowexec)
 
-flowexec is the primary tool for running a whole project, for building individual targets
+`flowexec` is the primary tool for running a whole project, for building individual targets
 or for inspecting individual entitites.
+
+## General Parameters
+* `-h` displays help
+* `-f <project_directory>` specifies a different directory than the current for locating a Flowman project
+* `-P <profile_name>` activates a profile as being defined in the Flowman project
+* `-D <key>=<value>` Sets a environment variable
+* `--conf <key>=<value>` Sets a Flowman or Spark configuration variable
+* `--info` Dumps the active configuration to the console
+* `--spark-logging <level>` Sets the log level for Spark 
+* `--spark-name <application_name>` Sets the Spark application name
+
+
+## Project Commands
+The most important command group is for executing a specific lifecycle or a individual phase for the whole project.
+```shell script
+flowexec project <create|build|verify|truncate|destroy> <args>
+```
+This will execute the whole job by executing the desired lifecycle for the `main` job
+
+
+## Job Commands
+Similar to the project commands, individual jobs with different names than `main` can be executed.
+
+### List Jobs
+The following command will list all jobs defined in a project
+```shell script
+flowexec job list
+```
+
+### Execute Job phase
+```shell script
+flowexec job <create|build|verify|truncate|destroy> <job_name> <args>
+```
+
+## Target Commands
+
+### List Targets
+```shell script
+flowexec target list
+```
+
+### Execute Target phase
+```shell script
+flowexec job <create|build|verify|truncate|destroy> <job_name> <args>
+```

docs/cli/flowexec.md

@@ -0,0 +1 @@
+# Flowman Server

docs/cli/flowserver.md

@@ -0,0 +1,7 @@
+# Flowman Executables
+
+Flowman provides a small set of executables for working with projects.
+
+## Executables
+* [Flowman Executor](flowexec.md)
+* [Flowman Server](flowserver.md)

docs/cli/index.md

@@ -0,0 +1,185 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Flowman documentation build configuration file, created by
+# sphinx-quickstart on Fri Jan 17 10:12:21 2020.
+#
+# 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 = [
+    'recommonmark',
+    'sphinx.ext.autodoc'
+]
+
+# 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', '.md']
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Flowman'
+copyright = '2020, Kaya Kupferschmidt'
+author = 'Kaya Kupferschmidt'
+
+github_doc_root = 'https://github.com/dimajix/flowman/tree/master/docs/'
+
+# 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 = '0.12'
+# The full version, including alpha/beta/rc tags.
+release = '0.12.2-SNAPSHOT'
+
+# 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 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 = False
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# 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 = 'Flowmandoc'
+
+
+# -- 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, 'Flowman.tex', 'Flowman Documentation',
+     'Kaya Kupferschmidt', '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, 'flowman', 'Flowman 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, 'Flowman', 'Flowman Documentation',
+     author, 'Flowman', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+from recommonmark.transform import AutoStructify
+
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+        #'auto_toc_tree_section': 'Contents',
+        'auto_toc_tree_section': False,
+        'enable_auto_toc_tree': True,
+        'enable_eval_rst': True,
+        'enable_math': False,
+        'enable_inline_math': False
+    }, True)
+    app.add_transform(AutoStructify)

docs/conf.py

@@ -0,0 +1,8 @@
+# Flowman Cookbook
+
+This part of the documentation contains approaches to common problems
+
+
+## Cookbooks
+
+* [Testing](testing.md) How to implement tests in Flowman

docs/cookbook/index.md

@@ -0,0 +1 @@
+# Testing