Merge pull request #375 from moremoban/dev

release 0.7.2 - use templates over internet

Author: chfw

.moban.cd/changelog.yml

@@ -1,6 +1,12 @@
 name: moban
 organisation: moremoban
 releases:
+  - changes:
+      - action: Added
+        details:
+          - "Support for templates and configuration files over HTTP(S) protocol with httpfs! Yepee!"
+    date: 1.5.2020
+    version: 0.7.2
   - changes:
       - action: Fixed
         details:

.moban.cd/moban.yml

@@ -4,9 +4,9 @@ organisation: moremoban
 author: C. W.
 contact: [email protected]
 license: MIT
-version: 0.7.1
-current_version: 0.7.1
-release: 0.7.1
+version: 0.7.2
+current_version: 0.7.2
+release: 0.7.2
 branch: master
 master: index
 command_line_interface: "moban"

CHANGELOG.rst

@@ -1,6 +1,14 @@
 Change log
 ================================================================================
 
+0.7.2 - 1.5.2020
+--------------------------------------------------------------------------------
+
+**Added**
+
+#. Support for templates and configuration files over HTTP(S) protocol with
+   httpfs! Yepee!
+
 0.7.1 - 25.04.2020
 --------------------------------------------------------------------------------
 

README.rst

@@ -41,15 +41,26 @@ Introduction
 ================================================================================
 
 **moban** started with bringing the high performance template engine (JINJA2) for web
-into static text generation. It has been used in `pyexcel` and `coala` project to keep
-documentation consistent across the documentations of individual libraries in the same
-organisation.
+into static text generation. 
 
 **moban** can use other python template engine: mako, handlebars, velocity,
 haml, slim and tornado, can read other data format: json and yaml, and can access both
 template file and configuration file in
 any location: zip, git, pypi package, s3, etc.
 
+
+It has been used in `pyexcel <https://github.com/pyexcel/pyexcel>`_ and
+`coala <https://github.com//coala/coala>`_ project to keep
+documentation consistent across the documentations of individual libraries in the same
+organisation.
+
+And here is a list of other usages:
+
+1. `Django Mobans <https://github.com/django-mobans>`_, templates for django, docker etc.
+1. `Math Sheets <https://github.com/chfw/math-sheets>`_, generate custom math sheets
+   in pdf
+
+
 Vision
 ================================================================================
 
@@ -58,7 +69,7 @@ Any template, any data in any location
 Support
 ================================================================================
 
-If you like moban, please support me on `github <https://github.com/sponsors/chfw>`_,
+If you like moban, please support me on,
 `patreon <https://www.patreon.com/bePatron?u=5537627>`_
 or `bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>`_ to maintain
 the project and develop it further.
@@ -69,7 +80,7 @@ a little bit more time in coding, documentation and writing interesting extensio
 Credit
 ================================================================================
 
-`jinja2-fsloader` is the key component to enable PyFilesystem2 support in moban
+`jinja2-fsloader <https://github.com/althonos/jinja2-fsloader>`_ is the key component to enable PyFilesystem2 support in moban
 v0.6x. Please show your stars there too!
 
 Installation
@@ -150,7 +161,23 @@ Moban in live action:
 All use cases are documented `here <http://moban.readthedocs.org/en/latest/#tutorial>`_
 
 
-Work with files in a git repo
+Templates and configuration files over HTTP(S)
+================================================================================
+
+`httpfs <https://github.com/moremoban/httpfs>`_ should be installed first.
+
+.. code-block:: bash
+
+    $ moban -t 'https://raw.githubusercontent.com/moremoban/pypi-mobans/dev/templates/_version.py.jj2'\
+      -c 'https://raw.githubusercontent.com/moremoban/pypi-mobans/dev/config/data.yml'\
+      -o _version.py
+
+
+In an edge case, if github repo's public url is given,
+this github repo shall not have sub repos. This library will fail to
+translate sub-repo as url. No magic.
+
+Templates and configuration files in a git repo
 ================================================================================
 
 `gitfs2 <https://github.com/moremoban/gitfs2>`_ is optional since v0.7.0 but was
@@ -172,7 +199,7 @@ You can do the following with moban:
     __author__ = "C.W."
 
 
-Work with files in a python package
+Templates and configuration files in a python package
 ================================================================================
 
 `pypifs <https://github.com/moremoban/pypifs>`_ is optional since v0.7.0 but

docs/README.rst

@@ -26,6 +26,7 @@ This section covers the use cases for moban. Please check them out individually.
 #. `Template copying from a zip to a zip`_
 #. `Intermeidate targets`_
 #. `Mobanfile inheritance`_
+#. `Files over http(s)`_
 
 .. _Jinja2 command line: level-1-jinja2-cli
 .. _Template inheritance: level-2-template-inheritance
@@ -50,4 +51,4 @@ This section covers the use cases for moban. Please check them out individually.
 .. _Template copying from a zip to a zip: level-21-copy-templates-into-an-alien-file-system
 .. _Intermeidate targets: level-22-intermediate-targets
 .. _Mobanfile inheritance: level-23-inherit-organisational-moban-file
-
+.. _Files over http(s): level-24-files-over-http

docs/conf.py

@@ -25,9 +25,9 @@
 copyright = '2017-2020 Onni Software Ltd.'
 author = 'C. W.'
 # The short X.Y version
-version = '0.7.1'
+version = '0.7.2'
 # The full version, including alpha/beta/rc tags
-release = '0.7.1'
+release = '0.7.2'
 
 # -- General configuration ---------------------------------------------------
 

docs/index.rst

@@ -38,6 +38,7 @@ examples folder.
    level-21-copy-templates-into-an-alien-file-system/README.rst
    level-22-intermediate-targets/README.rst
    level-23-inherit-organisational-moban-file/README.rst
+   level-24-files-over-http/README.rst
 
 
 For more complex use case, please look at `its usage in pyexcel project <http://pyexcel.readthedocs.io/en/latest/guide.html>`_

docs/level-24-files-over-http/.moban.yml

@@ -0,0 +1,10 @@
+configuration:
+  template_dir:
+    - "https://raw.githubusercontent.com/moremoban/pypi-mobans/dev/templates/"
+    - local
+  configuration: config.yml
+  configuration_dir: >-
+    https://raw.githubusercontent.com/moremoban/pypi-mobans/dev/config/
+targets:
+  - mytravis.yml: travis.yml.jj2
+  - test.txt: demo.txt.jj2

docs/level-24-files-over-http/README.rst

@@ -0,0 +1,54 @@
+level 24: templates and configuration files over http(s)
+================================================================================
+
+.. note::
+
+   You will need to install httpfs
+
+Why not to take a template off the web? Once a template is written somewhere
+by somebody, as long as it is good and useful, it is always to reuse it,
+isn't it? DRY principle kicks in.
+
+Now with mobanfile, it is possible to package up your mobans/templates and
+configuration files from a HTTP(S) protocol.
+
+
+Here are the sample file::
+
+   configuration:
+     template_dir:
+       - "https://raw.githubusercontent.com/moremoban/pypi-mobans/dev/templates/"
+       - local
+     configuration: config.yml
+     configuration_dir: "https://raw.githubusercontent.com/moremoban/pypi-mobans/dev/config/"
+   targets:
+     - mytravis.yml: travis.yml.jj2
+     - test.txt: demo.txt.jj2
+
+When you refer to it in configuration section, here is the syntax::
+
+   configuration:
+     template_dir:
+       - "https://raw.githubusercontent.com/moremoban/pypi-mobans/dev/templates/"
+
+.. warn::
+
+   The trailing '/' must be there.
+
+
+Maintenance note
+--------------------------------------------------------------------------------
+
+To the maintainer, in order to eat the dog food. Please checkout pypi-mobans
+and run a http server inside local pypi-mobans folder.
+
+Then update moban's mobanfile to::
+
+   configuration:
+     template_dir:
+       - "http://localhost:8000/templates/"
+       - "http://localhost:8000/statics/"
+       - ".moban.d"
+
+Then run `make update`
+

docs/level-24-files-over-http/config.yml

@@ -0,0 +1,2 @@
+overrides: data.yml
+level24: "files over http protocol"