Merge pull request #81 from moremoban/dev

release 0.2.3

Author: chfw

.gitignore

@@ -242,7 +242,8 @@ flycheck_*.el
 # Swap
 [._]*.s[a-v][a-z]
 [._]*.sw[a-p]
-[._]s[a-v][a-z]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
 [._]sw[a-p]
 
 # Session
@@ -263,6 +264,7 @@ tags
 # User-specific stuff
 .idea/**/workspace.xml
 .idea/**/tasks.xml
+.idea/**/usage.statistics.xml
 .idea/**/dictionaries
 .idea/**/shelf
 
@@ -280,8 +282,7 @@ tags
 .idea/**/libraries
 
 # CMake
-cmake-build-debug/
-cmake-build-release/
+cmake-build-*/
 
 # Mongo Explorer plugin
 .idea/**/mongoSettings.xml
@@ -414,7 +415,7 @@ local.properties
 # CDT-specific (C/C++ Development Tooling)
 .cproject
 
-# CDT- autotools 
+# CDT- autotools
 .autotools
 
 # Java annotation processor (APT)
@@ -438,6 +439,9 @@ local.properties
 # Code Recommenders
 .recommenders/
 
+# Annotation Processing
+.apt_generated/
+
 # Scala IDE specific (Scala & Java development for Eclipse)
 .cache-main
 .scala_dependencies

.moban.cd/changelog.yml

@@ -1,14 +1,22 @@
 name: moban
 organisation: moremoban
 releases:
+- changes:
+  - action: Added
+    details:
+    - "`#76`: running moban as a module from python command"
+    - "`#32`: copy a directory recusively"
+    - "`#33`: template all files in a directory"
+  date: 10-07-2018
+  version: 0.2.3
 - changes:
   - action: Added
     details:
     - "`#31`: create directory if missing during copying"
   - action: Updated
     details:
     - "`#28`: if a template has been copied once before, it is skipped in the next moban call"
-  date: unreleased
+  date: 16-06-2018
   version: 0.2.2
 - changes:
   - action: Updated

.moban.cd/moban.yml

@@ -3,9 +3,9 @@ organisation: moremoban
 author: C. W.
 contact: [email protected]
 license: MIT
-version: 0.2.2
-current_version: 0.2.2
-release: 0.2.2
+version: 0.2.3
+current_version: 0.2.3
+release: 0.2.3
 branch: master
 command_line_interface: "moban"
 entry_point: "moban.main:main"

CHANGELOG.rst

@@ -1,7 +1,20 @@
 Change log
 ================================================================================
 
-0.2.2 - unreleased
+0.2.3 - 10-07-2018
+--------------------------------------------------------------------------------
+
+Added
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. `#76 <https://github.com/moremoban/moban/issues/76>`_: running moban as a
+   module from python command
+#. `#32 <https://github.com/moremoban/moban/issues/32>`_: copy a directory
+   recusively
+#. `#33 <https://github.com/moremoban/moban/issues/33>`_: template all files in
+   a directory
+
+0.2.2 - 16-06-2018
 --------------------------------------------------------------------------------
 
 Added

docs/conf.py

@@ -3,42 +3,180 @@
     'Yet another jinja2 cli command for static text generation' +
     ''
 )
+# -*- 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 = u'moban'
+copyright = u'2017-2018 Onni Software Ltd.'
+author = u'C. W.'
+
+# The short X.Y version
+version = u'0.2.3'
+# The full version, including alpha/beta/rc tags
+release = u'0.2.3'
+
+
+# -- 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.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.viewcode',
 ]
-intersphinx_mapping = {
-}
+
+# 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'
 
-project = u'moban'
-copyright = u'2017-2018 Onni Software Ltd.'
-version = '0.2.2'
-release = '0.2.2'
+# 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 = 'en'
+
+# 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 = []
+
+# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
-html_theme = 'default'
+
+
+# -- 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 = 'mobandoc'
-latex_elements = {}
+
+
+# -- 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 = [
-    ('index', 'moban.tex',
-     'moban Documentation',
-     'Onni Software Ltd.', 'manual'),
+    (master_doc, 'moban.tex', u'moban Documentation',
+     u'Onni Software Ltd.', 'manual'),
 ]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'moban',
-     'moban Documentation',
-     [u'Onni Software Ltd.'], 1)
+    (master_doc, 'moban', u'moban 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, 'moban', u'moban Documentation',
+     author, 'moban', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+# -- Extension configuration -------------------------------------------------
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+# TODO: html_theme not configurable upstream
+html_theme = 'default'
+
+# TODO: DESCRIPTION not configurable upstream
 texinfo_documents = [
     ('index', 'moban',
      'moban Documentation',
      'Onni Software Ltd.', 'moban',
      DESCRIPTION,
      'Miscellaneous'),
 ]
+intersphinx_mapping.update({
+})

docs/level-8-pass-a-folder-full-of-templates/.moban.yml

@@ -0,0 +1,7 @@
+configuration:
+  configuration_dir: 'config'
+  configuration: level8.yml
+  template_dir:
+    - template-folder
+targets:
+  - templated-folder: templates

docs/level-8-pass-a-folder-full-of-templates/README.rst

@@ -0,0 +1,11 @@
+Level 8: Pass a folder full of templates
+================================================================================
+
+We already know that in moban file, you can pass
+on a dictionary in targets section, and it apply the template. The assumption
+was that the template parameter is a file. Now, what if the parameter is a
+directory?
+
+When you pass a directory with full of templates, moban will also assume the
+target is a directory and will generate the output there. When saving the
+files, it will remove its file suffices automatically.

docs/level-8-pass-a-folder-full-of-templates/config/level8.yml

@@ -0,0 +1 @@
+a: "test"

docs/level-8-pass-a-folder-full-of-templates/template-folder/templates/my.jj2

@@ -0,0 +1 @@
+it is a {{a}}

moban/__init__.py

@@ -1,2 +1,4 @@
-__version__ = "0.0.7"
-__author__ = "C.W."
+from moban._version import __version__
+from moban._version import __author__
+
+__all__ = ("__author__", "__version__")