kkpy-cli 0.1.1__py3-none-any.whl

kkpy_cli/cli.py

@@ -0,0 +1,197 @@
+import os
+import sys
+import logging
+
+import click
+import coloredlogs
+
+from kkpy.template import Template, TemplateEnv, TemplateVirtualEnv
+from kkpy_cli.utils import (
+    cli_args,
+    NotADirectory
+)
+
+coloredlogs.install()
+logging.basicConfig(
+    level=logging.DEBUG,
+    format='[%(asctime)s] {%(filename)s:%(lineno)d} %(levelname)s - %(message)s',
+    stream=sys.stdout
+)
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+@click.group()
+@click.version_option(package_name='kkpy-cli')
+def commands():
+    pass
+
+@commands.command('init')
+@click.option('-d', '--dir_path', metavar='PATH', help='Specify directory to save the template files. ')
+@cli_args.ENV_OPTS
+@cli_args.PYTHON_VERSION
+def init(env, dir_path, python):
+    """
+    Initialize a python template for development.
+    """
+
+    # check the directory
+    if not dir_path:
+        dir_path = os.getcwd()
+
+    if not os.path.exists(dir_path):
+        os.makedirs(dir_path, exist_ok=True)
+    elif not os.path.isdir(dir_path):
+        raise NotADirectory(dir_path)
+
+    # set the target directory path to env KKPY_PROJECT_HOME
+    project_home = os.path.abspath(dir_path)
+
+    from kkpy_cli.commands.init import init_project
+    init_project(env=env, project_home=project_home, python_version=python)
+
+@commands.command('build')
+@cli_args.ENV_OPTS
+@cli_args.PYTHON_VERSION
+def build(env, python):
+    """
+    Build from an existing python template for development.
+    """
+
+    # check the template files is exist.
+    if not os.path.isfile(os.path.join(os.getcwd(), TemplateVirtualEnv.TEMPLATE_REQUIREMENTS)):
+        print(f"""
+\033[91mCommand execute failed, because it can't find template files.\033[0m
+
+\033[94mPlease check\033[0m \033[1m2\033[0m \033[94mitems:\033[0m
+
+    1. switch directory to project root directory.
+    2. ensure the template files exists in project root directory.
+        """)
+
+        exit(-1)
+
+    # set the target directory path to env KKPY_PROJECT_HOME
+    project_home = os.path.abspath(os.getcwd())
+
+    from kkpy_cli.commands.build import build_project
+    build_project(env=env, project_home=project_home, python_version=python)
+
+@commands.command('install')
+def install():
+    """
+    Install dependency from requirements.txt.
+    """
+
+    # check the template files is exist.
+    if not os.path.isfile(os.path.join(os.getcwd(), TemplateVirtualEnv.TEMPLATE_REQUIREMENTS)):
+        print(f"""
+\033[91mCommand execute failed, because it can't find template files.\033[0m
+
+\033[94mPlease check\033[0m \033[1m2\033[0m \033[94mitems:\033[0m
+
+    1. switch directory to project root directory.
+    2. ensure the template files exists in project root directory.
+        """)
+
+        exit(-1)
+
+    # set the target directory path to env KKPY_PROJECT_HOME
+    project_home = os.path.abspath(os.getcwd())
+
+    from kkpy_cli.commands.install import install_dependency
+    install_dependency(project_home=project_home)
+
+@commands.command('test')
+@cli_args.ARGS
+def test(args):
+    """
+    Start unit test tasks to test src.
+
+    Any arguments which base on \033[1mtox\033[0m can be passed, e.g. \033[94mkkpy test -- "--recreate --skip-pkg-install"\033[0m
+    """
+
+    if not args:
+        args = ''
+
+    # load env file from project root path
+    load_env_file()
+
+    from kkpy_cli.commands.test import test_project
+    code = test_project(tox_args=args)
+
+    if code != 0:
+        sys.exit(f'test error with exit code:{code}')
+
+@commands.command('run')
+@cli_args.ARGS
+def run(args):
+    """
+    Run python procress from project which using the kkpy template.
+
+    Any arguments can be passed, if you already dinfine input args in bin/start.py , e.g. \033[94mkkpy run -- "--exec_date 2021-01-01"\033[0m
+    """
+
+    if not args:
+        args = ''
+
+    # load env file from project root path
+    load_env_file()
+
+    from kkpy_cli.commands.run import run_project
+    code = run_project(args=args)
+
+    if code != 0:
+        sys.exit(f'run error with exit code:{code}')
+
+@commands.command('clean')
+def clean():
+    """
+    Clean project directory, it will remove .venv and .env.
+    """
+
+    # load env file from project root path
+    load_env_file()
+
+    from kkpy_cli.commands.clean import clean_project
+    clean_project()
+
+@commands.command('env')
+def env():
+    """
+    Display information about the current project environment.
+    """
+
+    load_env_file()
+
+    print(f"""
+\033[95mConfigure Information From\033[0m: {os.environ['KKPY_ENV_PATH']}
+
+\033[1mEnvironment\033[0m
+\033[94mName\033[0m: {os.environ['KKPY_ENV']}
+
+\033[1mProject\033[0m
+\033[94mName\033[0m: {os.environ['KKPY_PROJECT_NAME']}
+\033[94mHome\033[0m: {os.environ['KKPY_PROJECT_HOME']}
+
+\033[1mVirtualenv\033[0m
+\033[94mPython\033[0m: {os.environ['KKPY_PYTHON_VERSION']} ({os.environ['KKPY_VIRTUALENV_PATH']}/bin/python)
+\033[94mPath\033[0m:   {os.environ['KKPY_VIRTUALENV_PATH']}
+""")
+
+def load_env_file(env_directory=os.getcwd()):
+    env_is_exist = TemplateEnv.check_is_exist(env_directory=env_directory)
+    if not env_is_exist:
+        # alert and hint
+        print(f"""
+\033[91mCommand execute failed, because it can't find .env file.\033[0m
+
+\033[94mPlease check\033[0m \033[1m2\033[0m \033[94mitems:\033[0m
+
+    1. switch directory to project root directory.
+    2. ensure the .env file exists in project root directory.
+        """)
+
+        exit(-1)
+    else:
+        templ_env = TemplateEnv(template_home=env_directory)
+        templ_env.load_to_env_vars()

kkpy_cli/commands/build.py

@@ -0,0 +1,34 @@
+import os
+import logging
+
+from kkpy.template import Template, TemplateEnv, TemplateVirtualEnv
+
+
+def build_project(env, project_home, python_version):
+    # check .env
+    env_is_exist = TemplateEnv.check_is_exist(env_directory=project_home)
+    if env_is_exist:
+        # target folder already initialize before
+        print(f"""
+\033[91mIt has already been initialized.\033[0m
+\033[91mIf you want to re-init, please use `kkpy clean` and `kkpy build`.\033[0m
+        """)
+        exit(-1)
+    else:
+        templ_env = TemplateEnv(template_home=project_home)
+        templ_env.env = env
+
+    logging.info(f"start to initialize: {os.path.basename(project_home)}")
+
+    # create template without generate
+    templ = Template(template_home=project_home)
+
+    # create virtualenv
+    templ_venv = TemplateVirtualEnv(template_home=project_home,
+                                    python_version=python_version)
+    templ_venv.build()
+    templ_env.py_ver = templ_venv.py_ver
+    templ_env.venv_path = templ_venv.path
+
+    # create .env file in project root directory
+    templ_env.create()

kkpy_cli/commands/clean.py

@@ -0,0 +1,19 @@
+import logging
+import os
+import shutil
+
+
+def clean_project():
+    logging.info(f"clean project at: {os.environ.get('KKPY_PROJECT_HOME')}")
+
+    # remove .venv
+    venv_conf_path = os.environ.get('KKPY_VIRTUALENV_CONF_PATH')
+    if os.path.exists(venv_conf_path):
+        logging.info(f"remove virtualenv conf dir: {venv_conf_path}")
+        shutil.rmtree(venv_conf_path)
+
+    # remove .env
+    env_path = os.environ.get('KKPY_ENV_PATH')
+    if os.path.isfile(env_path):
+        logging.info(f"remove env file: {env_path}")
+        os.remove(env_path)

kkpy_cli/commands/init.py

@@ -0,0 +1,34 @@
+import os
+import logging
+
+from kkpy.template import Template, TemplateEnv, TemplateVirtualEnv
+
+def init_project(env, project_home, python_version):
+    # check .env
+    env_is_exist = TemplateEnv.check_is_exist(env_directory=project_home)
+    if env_is_exist:
+        # target folder already initialize before
+        print(f"""
+\033[91mIt has already been initialized.\033[0m
+\033[91mIf you want to re-init, please use `kkpy clean` and `kkpy build`.\033[0m
+        """)
+        exit(-1)
+    else:
+        templ_env = TemplateEnv(template_home=project_home)
+        templ_env.env = env
+
+    logging.info(f"start to initialize: {os.path.basename(project_home)}")
+
+    # create template
+    templ = Template(template_home=project_home)
+    templ.generate()
+
+    # create virtualenv
+    templ_venv = TemplateVirtualEnv(template_home=project_home,
+                                    python_version=python_version)
+    templ_venv.build()
+    templ_env.py_ver = templ_venv.py_ver
+    templ_env.venv_path = templ_venv.path
+
+    # create .env file in project root directory
+    templ_env.create()

kkpy_cli/commands/install.py

@@ -0,0 +1,22 @@
+import os
+import logging
+
+from kkpy.template import TemplateEnv, TemplateVirtualEnv
+
+
+def install_dependency(project_home):
+    # check .env
+    env_is_exist = TemplateEnv.check_is_exist(env_directory=project_home)
+    if not env_is_exist:
+        # target folder already initialize before
+        print(f"""
+\033[91mIt has not been initialized.\033[0m
+\033[91mIf you want to install dependency, please use `kkpy init` or `kkpy build`.\033[0m
+        """)
+        exit(-1)
+
+    logging.info(f"start to install dependency")
+
+    # create virtualenv and install
+    templ_venv = TemplateVirtualEnv(template_home=project_home)
+    templ_venv.install()

kkpy_cli/commands/run.py

@@ -0,0 +1,23 @@
+import logging
+import os
+import platform
+
+def run_project(args=''):
+    os_name = platform.system().lower()
+    if os_name == 'linux':
+        exec_command = 'bash'
+    elif os_name == 'darwin':
+        exec_command = 'sh'
+    else:
+        # Don't support windows
+        logging.error('Unidentified Operating System.')
+        exit(-1)
+
+    exec_command += f" {os.environ.get('KKPY_PROJECT_HOME')}/bin/start.sh {args}"
+
+    if os.environ.get('KKPY_VIRTUALENV_PATH'):
+        code = os.system(f". {os.environ.get('KKPY_VIRTUALENV_PATH')}/bin/activate; {exec_command}")
+    else:
+        code = os.system(f". {exec_command}")
+
+    return code

kkpy_cli/commands/test.py

@@ -0,0 +1,15 @@
+import os
+import logging
+
+def test_project(**kwargs):
+    logging.info('================= [pytest] Start ==================')
+
+    tox_args = kwargs.get('tox_args', '')
+
+    exec_command = f"tox {tox_args}"
+    logging.info(f"exec command: {exec_command}")
+    code = os.system(f'. {os.environ.get("KKPY_VIRTUALENV_PATH")}/bin/activate; {exec_command}')
+
+    logging.info('================= [pytest] End ==================')
+
+    return code

kkpy_cli/utils/__init__.py

@@ -0,0 +1 @@
+from kkpy_cli.utils.exception import *

kkpy_cli/utils/cli_args.py

@@ -0,0 +1,21 @@
+import click
+
+ENV_OPTS = click.option(
+    '-e',
+    '--env',
+    type=click.Choice(['dev', 'sit', 'stage', 'prod']),
+    default='dev',
+    show_default=True,
+    help=''
+)
+
+PYTHON_VERSION = click.option(
+    '-p',
+    '--python',
+    help='Specify the full python version, e.g 3.6.10. '
+)
+
+ARGS = click.argument(
+    'args',
+    required=False
+)

kkpy_cli/utils/exception.py

@@ -0,0 +1,12 @@
+import platform
+
+__all__ = ['NotADirectory']
+
+
+class BuilderException(Exception):
+    pass
+
+
+class NotADirectory(BuilderException):
+    def __init__(self, path):
+        super(NotADirectory, self).__init__("Path '{}' is not a directory.".format(path))

kkpy_cli-0.1.1.dist-info/METADATA

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: kkpy-cli
+Version: 0.1.1
+Summary: A CLI to scaffold, build, test and run Python projects from a project template.
+Keywords: Python,Template,CLI
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: setuptools==57.0.0
+Requires-Dist: wheel==0.36.2
+Requires-Dist: virtualenv==20.4.7
+Requires-Dist: click==8.0.1
+Requires-Dist: python-dotenv==0.18.0
+Requires-Dist: coloredlogs==15.0.1
+Requires-Dist: importlib-metadata==3.10.1
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# kkpy-cli

kkpy_cli-0.1.1.dist-info/RECORD

@@ -0,0 +1,42 @@
+kkpy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kkpy/__version__.py,sha256=ls1camlIoMxEZz9gSkZ1OJo-MXqHWwKPtdPbZJmwp7E,22
+kkpy/template.py,sha256=nGsSC38iuhnR-4jwf5F2P_KwG7qtiMeQlMuLiawxAV8,8020
+kkpy/poetry/install-poetry.py,sha256=s10Fm-bzQ6wfBa5W6Oqq67NNqMkkJO4AEzgh1_EeOpw,23368
+kkpy/poetry/install.sh,sha256=LL3_HfiUbgGHdpP5nTiQIBqHpBmSlDLd2H9kxAaQTas,572
+kkpy/templates/.editorconfig,sha256=Pn1rDsfqMHfafXD88ypjWhkI0ocsBXiNEpMq-3OZdV8,263
+kkpy/templates/.gitignore,sha256=24wMnt7Kw2Fw_lXxkSv9cMiwTK07EtE-K_GRYkiHqUk,558
+kkpy/templates/.requirements-template.txt,sha256=uxmFYEgbpRy0lCSHEoBKCgIDq4fHdbQ6I3Go2EC6whQ,60
+kkpy/templates/.requirements-test.txt,sha256=Qav-C9STi3theJJoE27sGT3noTo-BEq_VgLZwyodAX4,45
+kkpy/templates/Jenkinsfile,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kkpy/templates/README.md,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kkpy/templates/tox.ini,sha256=vAb2mbZDzU1bEAaJcTtCiH_Xi8Xv5jeeA_cJuHkdDjY,466
+kkpy/templates/bin/start.py,sha256=5wB5gzEKHi_KCrDTrYV3iBir05STNmxxVQseOMHbleI,827
+kkpy/templates/bin/start.sh,sha256=hpj9Dt5-WsO_V7heVR8NEw4QMm2gzbOaX3qYhAlYNDs,182
+kkpy/templates/src/__init__.py,sha256=Go2xZ6bNLIqO1aJ7Emf0qwRpe4FvAdMBT_LWOWwNFWI,278
+kkpy/templates/src/main.py,sha256=IwjaMORkgyZiUIXdruK-boha-VrQkUklDx5WYxYZeLw,579
+kkpy/templates/src/requirements.txt,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kkpy/templates/src/configs/app.ini,sha256=R1fhxAMADISFU_mixVbH9RoNak7V3qvGQoZ2da31SCA,90
+kkpy/templates/src/configs/db.ini,sha256=_YT9sa8JG3ncAey51l_Pvpxe6qLwL3pYlj6tbIYNm28,105
+kkpy/templates/src/configs/logging_config.ini,sha256=4KKVK3uzs67QzmzHPu56oPd-qmUNdsMJGXIcXSkHaJE,504
+kkpy/templates/src/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kkpy/templates/src/utils/utils.py,sha256=vRagEzUIQJnqPRHc8N_4HJV4UM4c_eKUhARhs2h1nsc,2044
+kkpy/templates/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kkpy/templates/tests/conftest.py,sha256=uaA70g4x-g2M79GV8H6i1rRdwUfs92qm-wEAYTkUixk,140
+kkpy/templates/tests/test_sample.py,sha256=I8Nf447swmFpcAW_cjaD3_CABP9zwaICBA-98O__AAs,79
+kkpy_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kkpy_cli/cli.py,sha256=924u_99wQnCK92gP6hZQyOPHepkP9KGwp95_WOU_wLM,5429
+kkpy_cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kkpy_cli/commands/build.py,sha256=2b_OewvRrQOxuszYNMRsEh94qC5DwEGQ2uoqhxlCfRw,1088
+kkpy_cli/commands/clean.py,sha256=cqnrPr2IKV4Ff0FeemlNhSEgNGmosTa9I1K80m4Mjco,551
+kkpy_cli/commands/init.py,sha256=OGSUpo92bDytEPa8htiRmZ4mli8UHLupJkUftaw_J6g,1089
+kkpy_cli/commands/install.py,sha256=EYp7sFR1B_gfE_IXggXYCPpLHd4Dx7J2zblMQ4sPpuk,649
+kkpy_cli/commands/run.py,sha256=FSR3f-65ZFdsbcyqf1W2U1hVT_sRMLsd2B-sFzshP5Q,643
+kkpy_cli/commands/test.py,sha256=EQRWOnYQQY35_mg_u8VOYZTWip2Hjui8LAA4b342SZc,442
+kkpy_cli/utils/__init__.py,sha256=KR9-qCuqRtSkr_6DCdDkcgf--AwvhcFumz4wohvKTzA,39
+kkpy_cli/utils/cli_args.py,sha256=eZG1jD477GJMNR1J6wkBf4gY7nnWqcMhlCpHralf4vA,348
+kkpy_cli/utils/exception.py,sha256=XLJp99V4Kp37-Hq3q92tdp2jL9qOSWwDP31xuROkOfw,252
+kkpy_cli-0.1.1.dist-info/METADATA,sha256=RZlIWhGwBtpG1Qh9SDVTky5bfz62OQ1Kfl1wfQ70ns4,793
+kkpy_cli-0.1.1.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+kkpy_cli-0.1.1.dist-info/entry_points.txt,sha256=LruZj9XTLYR8HK7wfPRQdfSrkZSflNT1OAQRjJhFZaM,47
+kkpy_cli-0.1.1.dist-info/top_level.txt,sha256=PBiXT0uh18I6ig18qu4FdfBfmgq2ODL0hlh6iDN0d6c,14
+kkpy_cli-0.1.1.dist-info/RECORD,,

kkpy_cli-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

kkpy_cli-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+kkpy = kkpy_cli.cli:commands

kkpy_cli-0.1.1.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+kkpy
+kkpy_cli