Merge pull request #4 from py-universe/patch/feedback

Patch/feedback

Author: nyior

django_rest_cli/engine/commands/start_project.py

@@ -3,6 +3,7 @@
 
 from django_rest_cli.engine.cli.mixins import ProjectConfigMixin
 from django_rest_cli.engine.utils import (
+    display_project_setup_instructions,
     init_git_repo,
     install_dependencies,
     rename_file,
@@ -13,7 +14,9 @@
 
 class StartProject(ProjectConfigMixin, Base):
     @staticmethod
-    def __follow_up_start_project(name: str, directory: Optional[str] = None) -> None:
+    def __follow_up_start_project(
+        name: str, template_type: str, directory: Optional[str] = None
+    ) -> None:
         if directory is None:
             manage_dir: pathlib.Path = pathlib.Path(".") / name
         else:
@@ -35,6 +38,7 @@ def __follow_up_start_project(name: str, directory: Optional[str] = None) -> Non
 
         init_git_repo(manage_dir)
         install_dependencies(manage_dir)
+        display_project_setup_instructions(template_type)
 
     @classmethod
     async def __start(
@@ -48,7 +52,7 @@ async def __start(
         template: str = f"{what.name}_TEMPLATE_URL_{template_type.upper()}"
 
         await Base.run_cmd_command(directive, name, directory, template)
-        cls.__follow_up_start_project(name)
+        cls.__follow_up_start_project(name, template_type)
 
     @classmethod
     async def start_project(

django_rest_cli/engine/enums.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class Templates(Enum):
+    BASIC = "Basic"
+    MEDIOR = "Medior"
+    ADV = "Advanced"

django_rest_cli/engine/utils.py

@@ -7,6 +7,8 @@
 import inflect
 from termcolor import cprint
 
+from .enums import Templates
+
 
 def raise_error_message(error_text: str, exception: Exception):
     raise exception(error_text)
@@ -97,3 +99,41 @@ def pluralize(string):
     """
     pluralizer = inflect.engine()
     return pluralizer.plural(string)
+
+
+def display_project_setup_instructions(
+    template_type: str,
+) -> None:
+    if Templates.BASIC.value in template_type:
+        print_info_message(
+            "Project Run Steps:Run the following commands\n\n"
+            """pip install -r requirements.txt
+            NB: Skip the above command if dr-cli already installed dependencies \n"""
+            "python manage.py migrate \n"
+            "python manage.py runserver \n"
+            "point your browser to `http://localhost:8000/api/v1/docs to view docs \n"
+        )
+
+    if Templates.MEDIOR.value in template_type:
+        print_info_message(
+            "Project Run Steps: Run the following commands:\n\n"
+            """pip install -r requirements.txt
+            Then runpip install -r requirements-dev.txt
+            NB: Skip the above commands if dr-cli already installed dependencies \n"""
+            "pre-commit install \n"
+            "python manage.py makemigrations users \n"
+            "python manage.py migrate \n"
+            "python manage.py runserver \n"
+            "Point your browser to http://localhost:8000/api/v1/docs to view docs \n"
+        )
+
+    if Templates.ADV.value in template_type:
+        print_info_message(
+            "Project Run Steps: Run the following commands\n\n"
+            "pre-commit install \n"
+            "docker-compose up --build \n"
+            "Navigate to your project directory in a new terminal and run:\n\n"
+            "docker-compose exec web python manage.py makemigrations users \n"
+            "docker-compose exec web python manage.py migrate \n"
+            "Point your browser to http://localhost:8000/api/v1/docs to view docs \n"
+        )