🔥 no template available

docs/changelog.md

@@ -170,3 +170,21 @@
 
 ## [0.1.5] - 2021-01-07
 
+## [Unreleased]
+
+**Bugfix**
+
+- No template available
+	- Print a message when the lenght template list is 0
+
+**Enhancement**
+
+- Local install template
+	- Add a local installation of templates
+	- Add an update option to upgrade local templates from local source
+
+**Structure**
+
+- Distinct workflow and setup cmd
+	- Moves file to workflow or setup directories
+

git_improved/commands/setup.py → git_improved/setup/commands/setup.py

@@ -2,9 +2,8 @@
 import shutil
 import argparse
 import subprocess
-from ..templates import TEMPLATES
-from ..command import Command
-from ..changelog import Changelog
+from ...command import Command
+from ...changelog import Changelog
 from ..template import setup_project
 
 
@@ -50,4 +49,38 @@ def parser():
         return parser
 
     def run(*, directory=".", template=None, verbose=False):
-        setup_project(template=template, destination=directory)
+
+        releases_directory='docs/releases'
+        changelog_path='docs/changelog.md'
+        no_github_action=False
+
+        # create releases_directory and add a .gitkeep to ensure it wont be empty
+        release_gitkeep_path = os.path.join(releases_directory, '.gitkeep')
+        try:
+            open(release_gitkeep_path)
+            print('[Warning] GitHub action already exists. Make sure it contains configuration to document changes on release.')
+        except FileNotFoundError:
+            os.makedirs(releases_directory, exist_ok=True)
+            with open(release_gitkeep_path, 'w') as gitkeep:
+                pass
+            print('Releases directory created in:', releases_directory)
+
+        # create changelog if it doesn't exists
+        try:
+            changelog = Changelog.parse(changelog_path)
+        except FileNotFoundError:
+            directory = os.path.dirname(os.path.abspath(changelog_path))
+            os.makedirs(directory, exist_ok=True)
+            changelog = Changelog.parse(changelog_path)
+
+
+        if not is_git_initialized():
+            subprocess.call(['git', 'init'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+            subprocess.call(['git', 'branch -m master main'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+            print('Git repository initialized...')
+
+        commit_configuration()
+
+        # setup templates
+        if template is not None:
+            setup_project(template=template, destination=directory)

git_improved/commands/template.py → git_improved/setup/commands/template.py

@@ -1,9 +1,9 @@
 import argparse
 
-from ..exceptions import ValidationError
-from ..command import Command
-from ..template import Template, GitCredentials
-from ..shell import display_table
+from ...exceptions import ValidationError
+from ...command import Command
+from ...template import Template, GitCredentials
+from ...shell import display_table
 
 
 class TemplateCommand(metaclass=Command):
@@ -18,6 +18,11 @@ def parser():
         install_parser.add_argument("--user", help="username used to autenticate if required")
         install_parser.add_argument("--token", help="pass a token or password to authenticate if required")
 
+        local_install_parser = subparsers.add_parser("local", help="install a template from a local source")
+        local_install_parser.add_argument("alias", help="the name you want to use locally to reference this template")
+        local_install_parser.add_argument("source", help="local path where target template is located")
+        local_install_parser.add_argument("-u", "--upgrade", action="store_true", help="update the given template")
+
         update_parser = subparsers.add_parser("update", help="update given templates (default to all).")
         update_parser.add_argument("templates", nargs="*", help="if you pass a list of templates, only these templates will be updated...")
         update_parser.add_argument("-v", "--verbose", action="store_true", help="(verbose) display additional informations...")
@@ -34,20 +39,25 @@ def validate(args):
         if not args.command:
             raise ValidationError('You must specify a command')
 
-    def run(*, command, alias=None, search=None, branch=None, user=None, token=None, origin=None, templates=None, verbose=False):
+    def run(*, command, alias=None, search=None, branch=None, user=None, token=None, origin=None, source=None, upgrade=None, templates=None, verbose=False):
         git_template = Template()
 
         if command == "install":
             # ensure that user can read this repository (=> public repo or proper authentication)
             GitCredentials().require_credentials(repository=origin)
             git_template.install(template=alias, origin=origin, branch=branch)
+        elif command == "local":
+            git_template.local_install(template=alias, source=source, upgrade=upgrade)
         elif command == "update":
             templates = templates if templates else git_template.search()
             for template in templates:
                 git_template.update(template, verbose=verbose)
         elif command == "list":
             templates = git_template.search(query=search)
-            display_table(templates)
+            if len(templates) == 0:
+                print("no templates available")
+            else:
+                display_table(templates)
         elif command == "rm":
             for template in templates:
                 git_template.remove(template)

git_improved/template.py → git_improved/setup/template.py

@@ -1,15 +1,15 @@
 import os
 import re
 import json
-import shutil
 import requests
 import argparse
 import subprocess
 import importlib.util
 from getpass import getpass
+from distutils.dir_util import copy_tree, remove_tree
 from jinja2 import Environment, FileSystemLoader, select_autoescape
-from .shell import check_output, silent_call
-from .git import get_remote_origin, count_changes_from_remote
+from ..shell import check_output, silent_call
+from ..git import get_remote_origin, count_changes_from_remote
 
 
 def load_environment(template_path):
@@ -229,7 +229,30 @@ def install(self, *, template, origin, user=None, token=None, branch='main'):
         subprocess.call(['git', 'checkout', '-b', branch])
         subprocess.call(['git', 'pull', 'origin', branch])
         subprocess.call(['git', 'branch', '--set-upstream-to=origin/%s'%branch, branch])
-
+
+    def local_install(self, *, template:str, source:str, upgrade:bool):
+
+        template_path = os.path.join(self.templates_directory, template)
+
+        # ensure that --upgrade is used and the template directory exist
+        if (upgrade is True) and (os.path.isdir(template_path) is True):
+            self.remove(template=template)
+
+        self.manifest.add_template(template)
+        os.makedirs(template_path)
+
+        source_path = ""
+
+        if source.startswith(".") is True:
+            source_path = os.path.abspath(source)
+        else:
+            source_path = source
+
+        if os.path.isdir(source_path) is False:
+            raise NotADirectoryError()
+
+        copy_tree(source_path, template_path)
+        print('template upgraded:' if upgrade is True else 'template installed', template)
 
     def update(self, template, verbose=False):        
         template_path = os.path.join(self.templates_directory, template)
@@ -253,7 +276,7 @@ def remove(self, template):
         try:
             template_path = os.path.join(self.templates_directory, template)
             self.manifest.remove_template(template)
-            shutil.rmtree(template_path)
+            remove_tree(template_path)
         except FileNotFoundError as e:
             print("[Warning] %s not found!"%template_path)
         print('template removed:', template)

git_improved/commands/cancel.py → git_improved/workflow/commands/cancel.py

@@ -1,8 +1,8 @@
 import argparse
 import subprocess
-from ..menu import Menu
-from ..command import Command
-from ..git import get_local_branches, get_remote_branches, get_current_branch, delete_branch
+from ...menu import Menu
+from ...command import Command
+from ...git import get_local_branches, get_remote_branches, get_current_branch, delete_branch
 
 
 def select_branches():

git_improved/commands/done.py → git_improved/workflow/commands/done.py

@@ -2,10 +2,10 @@
 import uuid
 import argparse
 import subprocess
-from ..command import Command
-from ..constants import BRANCHES_PREFIXES, CATEGORIES_ICONS
-from ..changelog import Changelog
-from ..git import (
+from ...command import Command
+from ...constants import BRANCHES_PREFIXES, CATEGORIES_ICONS
+from ...changelog import Changelog
+from ...git import (
     get_current_branch, merge_squash, get_current_branch_commits,
     ensure_git_initialized, ensure_working_tree_clean, ensure_branch_mergeable
 )

git_improved/commands/release.py → git_improved/workflow/commands/release.py

@@ -1,11 +1,11 @@
 import re
 import argparse
 import subprocess
-from ..command import Command
-from ..changelog import Changelog
-from ..constants import CATEGORIES_ICONS
-from ..exceptions import ValidationError
-from ..git import get_current_branch, ensure_main_branch
+from ...command import Command
+from ...changelog import Changelog
+from ...constants import CATEGORIES_ICONS
+from ...exceptions import ValidationError
+from ...git import get_current_branch, ensure_main_branch
 
 
 # custom type used to parse semver

git_improved/commands/save.py → git_improved/workflow/commands/save.py

@@ -1,6 +1,6 @@
 import argparse
 import subprocess
-from ..command import Command
+from ...command import Command
 
 
 class SaveCommand(metaclass=Command):

git_improved/commands/unrelease.py → git_improved/workflow/commands/unrelease.py

@@ -1,11 +1,11 @@
 import re
 import argparse
 import subprocess
-from ..git import get_releases
-from ..menu import Menu
-from ..command import Command
-from ..changelog import Changelog
-from ..exceptions import ValidationError
+from ...git import get_releases
+from ...menu import Menu
+from ...command import Command
+from ...changelog import Changelog
+from ...exceptions import ValidationError
 
 
 def delete_release(version):

git_improved/commands/wip.py → git_improved/workflow/commands/wip.py

@@ -1,7 +1,7 @@
 import argparse
 import subprocess
-from ..command import Command
-from ..constants import BRANCHES_PREFIXES
+from ...command import Command
+from ...constants import BRANCHES_PREFIXES
 
 
 class WipCommand(metaclass=Command):

setup.py

@@ -1,5 +1,5 @@
 import setuptools
-from git_improved.constants import GITHUB_ICONS_URLS
+from src.git_improved.constants import GITHUB_ICONS_URLS
 
 
 def load_long_description():
@@ -16,20 +16,20 @@ def load_long_description():
     name='git-improved',
     description='Add commands to simplify release and publish operation from Git CLI.',
     version='0.1.5',
-    packages=setuptools.find_packages(),
+    packages=setuptools.find_packages(exclude=("tests")),
     entry_points={
         'console_scripts': [
-            'git-setup=git_improved.commands.setup:SetupCommand',
-            'git-template=git_improved.commands.template:TemplateCommand',
+            #'git-setup=git_improved.commands.setup:SetupCommand',
+            #'git-template=git_improved.commands.template:TemplateCommand',
 
-            'git-wip=git_improved.commands.wip:WipCommand',
-            'git-save=git_improved.commands.save:SaveCommand',
+            'git-wip=git_improved.workflow.commands.wip:WipCommand',
+            'git-save=git_improved.workflow.commands.save:SaveCommand',
 
-            'git-cancel=git_improved.commands.cancel:CancelCommand',
-            'git-done=git_improved.commands.done:DoneCommand',
+            'git-cancel=git_improved.workflow.commands.cancel:CancelCommand',
+            'git-done=git_improved.workflow.commands.done:DoneCommand',
 
-            'git-release=git_improved.commands.release:ReleaseCommand',
-            'git-unrelease=git_improved.commands.unrelease:UnreleaseCommand'
+            'git-release=git_improved.workflow.commands.release:ReleaseCommand',
+            'git-unrelease=git_improved.workflow.commands.unrelease:UnreleaseCommand'
         ]
     },
     install_requires=[