Turn the py file into an m4 script

Author: oleks

.gitignore

@@ -1,3 +1,4 @@
+install.py
 .mypy_cache/
 
 # Created by https://www.gitignore.io/api/vim,emacs,python

Makefile

@@ -0,0 +1,14 @@
+.PHONY: clean
+
+HEAD_PATH=.git/$(shell cat .git/HEAD | cut -d' ' -f2)
+
+install.py: \
+		install.py.m4 \
+		LICENSE \
+		Makefile \
+		$(HEAD_PATH)
+	m4 -P -D "HEAD_PATH=$(HEAD_PATH)" $< > $@
+	./git-ready-to-deploy.sh
+
+clean:
+	rm -f install.py

README.rst

@@ -71,7 +71,29 @@ The utility is implemented as a standalone Python file, |install_py|_.
 User Guide
 ==========
 
-Copy |install_py|_ into the directory containing the files that you would like
+Where is the Python script?
+---------------------------
+
+To ensure proper accreditation, manage releases, and reduce code
+duplication, ``install.py`` is generated from `an m4 template
+<install.py.m4>`_. To get the shell script, either:
+
+  1. Fetch the
+     `latest <https://github.com/oleks/install.py/releases/latest>`_
+     `release <https://github.com/oleks/install.py/releases>`_
+     of the shell script, or;
+  2. Type ``make`` to build it, if you happen to have the
+     `m4 macro processor <https://www.gnu.org/software/m4/m4.html>`_
+     installed.
+
+     Please note, the last step of building ``install.py`` is to
+     execute ``git-ready-to-deploy.sh``. This ensures a clean release
+     of ``install.py``, so long as you mind the exit code of ``make``.
+
+What do I do with the Python script?
+------------------------------------
+
+Copy ``install_py`` into the directory containing the files that you would like
 to install. Create an INI file, (e.g., called ``config.ini``) having a
 ``install.py`` section with the properties ``src_dir``, ``dst_dir``, and
 ``files``. The values of the properties may be arbitrary Python expressions,

git-ready-to-deploy.sh

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+
+# This file was generated from an m4 template.
+# Generation date-time (ISO 8601): 2018-06-22T10:10+00:00
+# Git repository URL: https://github.com/oleks/git-ready-to-deploy
+# Commit ID: 394c2b040558a890d33d996c402d6594d1e5dfc6
+
+# Copyright (c) 2016-2018 Oleks <[email protected]>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+set -euo pipefail
+
+failcode=1
+
+nlines=$(git status . --porcelain | wc -l)
+if [ ${nlines} -ne 0 ] ; then
+  cat <<EOF
+#####################################################
+# Nice! You have changes. Now commit or stash them. #
+#####################################################
+EOF
+  git status .
+  exit ${failcode}
+fi
+
+echo "Let me check your remote.."
+git remote update
+
+nlines=$(git cherry | (grep "^+" || true) | wc -l)
+if [ ${nlines} -ne 0 ] ; then
+  cat <<EOF
+#####################################
+# Nice! You have commits. Now push. #
+#####################################
+EOF
+  git status .
+  exit ${failcode}
+fi
+
+echo "Looks like you are up-to-date."

install.py renamed to install.py.m4

@@ -1,27 +1,19 @@
 #!/usr/bin/env python3
 
 # install.py — A simple, file-system-based install utility
-# See also https://github.com/oleks/install.py
-
-# Copyright (c) 2017 Oleks <[email protected]>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
+
+# This file was generated from an m4 template.
+m4_syscmd(`date -u --iso-8601=minutes |
+  sed "s/^/# Generation date-time (ISO 8601): /"')m4_dnl
+m4_syscmd(`git remote get-url origin |
+  tr ":" "/" |
+  sed "s/^git@/https:\\/\\//" |
+  sed "s/\\.git$//" |
+  sed "s/^/# Git repository URL: /"')m4_dnl
+m4_format(`# Commit ID: %s', m4_include(HEAD_PATH))m4_dnl
+
+m4_syscmd(`perl -pe "chomp if eof" LICENSE |
+  sed "s/^/# /"')
 
 import configparser
 import os.path