Add more metadata and usage for the deployment script
This commit is contained in:
parent
45ab55bcc0
commit
9ef9e6299f
3 changed files with 63 additions and 9 deletions
5
defaults
5
defaults
|
@ -6,4 +6,7 @@ export PROJECT_NAME="Project Name"
|
||||||
export PROJECT_CODENAME="project-codename"
|
export PROJECT_CODENAME="project-codename"
|
||||||
export VERSION=0.0.1
|
export VERSION=0.0.1
|
||||||
export DEPLOYMENT_PATH="${HOME}/repos/"
|
export DEPLOYMENT_PATH="${HOME}/repos/"
|
||||||
export DESCRIPTION=""
|
export DESCRIPTION=""
|
||||||
|
export AUTHOR_EMAIL=""
|
||||||
|
export URL=""
|
||||||
|
export LICENSE="GPLv2"
|
|
@ -1,41 +1,79 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
function usage() {
|
||||||
|
echo "$(basename "${0}" .sh) [--help|-h|-?] [--author|-a 'Author name'] [--authoring-date|-d 'date of creation'] [--project-name|-n 'Name of the project'] [--project-codename|-p short_project_name] [--version|-v 'version number'] [--deployment-path|-r 'path/to/copy/skeleton'] [--author-email|-e 'email@example.org'] [--url|-u 'https://domain.com'] [--license|-l 'LICENSEv1']"
|
||||||
|
echo ""
|
||||||
|
echo " --help Show this help."
|
||||||
|
echo " --author Author name, between quotes for spaces."
|
||||||
|
echo " --authoring-date Date when the script was created."
|
||||||
|
echo " --project-name Long name of the project."
|
||||||
|
echo " --project-codename Short name without spaces for command line script."
|
||||||
|
echo " --version Initial version 0.0.1?"
|
||||||
|
echo " --deployment-path Path to deploy the skeleton."
|
||||||
|
echo " --author-email Email address of the author."
|
||||||
|
echo " --url URL of the project."
|
||||||
|
echo " --license License name."
|
||||||
|
if [ -e "$(dirname "${0}")/defaults" ]
|
||||||
|
then
|
||||||
|
echo "Defaults:"
|
||||||
|
cat "$(dirname "${0}")/defaults"
|
||||||
|
fi
|
||||||
|
}
|
||||||
# shellcheck disable=SC1090
|
# shellcheck disable=SC1090
|
||||||
if [ -e defaults ]
|
if [ -e "$(dirname "${0}")/defaults" ]
|
||||||
then
|
then
|
||||||
. "$(dirname "${0}")/defaults"
|
. "$(dirname "${0}")/defaults"
|
||||||
fi
|
fi
|
||||||
while [ $# -gt 0 ]
|
while [ $# -gt 0 ]
|
||||||
do
|
do
|
||||||
case "$1" in
|
case "$1" in
|
||||||
"--author")
|
"--help"|"-h"|"-?")
|
||||||
|
usage
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
"--author"|"-a")
|
||||||
shift
|
shift
|
||||||
AUTHOR="${1}"
|
AUTHOR="${1}"
|
||||||
shift
|
shift
|
||||||
;;
|
;;
|
||||||
"--authoring-date")
|
"--authoring-date"|"-d")
|
||||||
shift
|
shift
|
||||||
AUTHORING_DATE="${1}"
|
AUTHORING_DATE="${1}"
|
||||||
shift
|
shift
|
||||||
;;
|
;;
|
||||||
"--project-name")
|
"--project-name"|"-n")
|
||||||
shift
|
shift
|
||||||
PROJECT_NAME="${1}"
|
PROJECT_NAME="${1}"
|
||||||
;;
|
;;
|
||||||
"--project-codename")
|
"--project-codename"|"-p")
|
||||||
shift
|
shift
|
||||||
PROJECT_CODENAME="${1}"
|
PROJECT_CODENAME="${1}"
|
||||||
shift
|
shift
|
||||||
;;
|
;;
|
||||||
"--version")
|
"--version"|"-v")
|
||||||
shift
|
shift
|
||||||
VERSION="${1}"
|
VERSION="${1}"
|
||||||
shift
|
shift
|
||||||
;;
|
;;
|
||||||
"--deployment-path")
|
"--deployment-path"|"-r")
|
||||||
shift
|
shift
|
||||||
DEPLOYMENT_PATH="${1}"
|
DEPLOYMENT_PATH="${1}"
|
||||||
shift
|
shift
|
||||||
;;
|
;;
|
||||||
|
"--author-email"|"-e")
|
||||||
|
shift
|
||||||
|
AUTHOR_EMAIL="${1}"
|
||||||
|
shift
|
||||||
|
;;
|
||||||
|
"--url"|"-u")
|
||||||
|
shift
|
||||||
|
URL="${1}"
|
||||||
|
shift
|
||||||
|
;;
|
||||||
|
"--license"|"-l")
|
||||||
|
shift
|
||||||
|
LICENSE="${1}"
|
||||||
|
shift
|
||||||
|
;;
|
||||||
*)
|
*)
|
||||||
echo "Ignoring unknwon parameter '${1}'"
|
echo "Ignoring unknwon parameter '${1}'"
|
||||||
shift
|
shift
|
||||||
|
@ -52,7 +90,10 @@ while read -r file
|
||||||
do
|
do
|
||||||
sed -i "s/__project_codename__/${PROJECT_CODENAME}/g" "${file}"
|
sed -i "s/__project_codename__/${PROJECT_CODENAME}/g" "${file}"
|
||||||
sed -i "s/__author__/${AUTHOR}/g" "${file}"
|
sed -i "s/__author__/${AUTHOR}/g" "${file}"
|
||||||
|
sed -i "s/__author_email__/${AUTHOR_EMAIL}/g" "${file}"
|
||||||
sed -i "s/__authoring_date__/${AUTHORING_DATE}/g" "${file}"
|
sed -i "s/__authoring_date__/${AUTHORING_DATE}/g" "${file}"
|
||||||
sed -i "s/__project_name__/${PROJECT_NAME}/g" "${file}"
|
sed -i "s/__project_name__/${PROJECT_NAME}/g" "${file}"
|
||||||
sed -i "s/__version__/${VERSION}/g" "${file}"
|
sed -i "s/__version__/${VERSION}/g" "${file}"
|
||||||
|
sed -i "s/__url__/${URL}/g" "${file}"
|
||||||
|
sed -i "s/__license__/${LICENSE}/g" "${file}"
|
||||||
done <<< "$(ls "${destination_path}/")"
|
done <<< "$(ls "${destination_path}/")"
|
|
@ -1,2 +1,12 @@
|
||||||
import setuptools
|
import setuptools
|
||||||
setuptools.setup()
|
setuptools.setup(
|
||||||
|
scripts=['__project_codename__/__project_codename__.py'],
|
||||||
|
author="__author__",
|
||||||
|
version='__version__',
|
||||||
|
name='__project_codenane__',
|
||||||
|
author_email="__author_email__",
|
||||||
|
url="__url__",
|
||||||
|
description="__description__",
|
||||||
|
license="__license__",
|
||||||
|
#keywords=["my", "script", "does", "things"]
|
||||||
|
)
|
||||||
|
|
Loading…
Reference in a new issue