fixed --help cli command error

Author: eadwinCode

.github/workflows/publish.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.6
+          python-version: 3.8
       - name: Install Flit
         run: pip install flit
       - name: Install Dependencies

.github/workflows/test_full.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
 
     steps:
       - uses: actions/checkout@v3

Makefile

@@ -36,7 +36,7 @@ test-cov: ## Run tests with coverage
 
 doc-deploy: ## Run Deploy Documentation
 	make clean
-	mkdocs gh-deploy --force
+	mkdocs gh-deploy --force --ignore-version
 
 
 pre-commit-lint: ## Runs Requires commands during pre-commit

ellar/cli/_main.py

@@ -44,9 +44,7 @@ def build_typers() -> None:
         options, args = getopt.getopt(
             sys.argv[1:],
             "p:",
-            [
-                "project=",
-            ],
+            ["project=", "help"],
         )
         app_name: t.Optional[str] = None
 

tests/test_cli/sample_app/example_project_2/commands.py

@@ -14,3 +14,9 @@ def create_migration():
 def whatever_you_want():
     """Whatever you want"""
     print("Whatever you want command from example_project_2")
+
+
+@command()
+def project_2_command():
+    """Project 2 Custom Command"""
+    print("Project 2 Custom Command from example_project_2")

tests/test_cli/sample_app/example_project_2/root_module.py

@@ -3,10 +3,10 @@
 from ellar.core.connection import Request
 from ellar.core.response import JSONResponse, Response
 
-from .commands import db, whatever_you_want
+from .commands import db, project_2_command, whatever_you_want
 
 
-@Module(commands=[db, whatever_you_want])
+@Module(commands=[db, whatever_you_want, project_2_command])
 class ApplicationModule(ModuleBase):
     @exception_handler(404)
     def exception_404_handler(cls, request: Request, exc: Exception) -> Response:

tests/test_cli/test_build_typers.py

@@ -52,3 +52,30 @@ def test_build_typers_command_for_specific_project_works():
     )
     assert result.returncode == 0
     assert result.stdout == b"Whatever you want command from example_project_2\n"
+
+
+def test_help_command(cli_runner):
+    os.chdir(sample_app_path)
+    result = subprocess.run(["ellar", "--help"], stdout=subprocess.PIPE)
+    assert result.returncode == 0
+    assert (
+        result.stdout
+        == b"Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -p, --project TEXT              Run Specific Command on a specific project\n  --install-completion [bash|zsh|fish|powershell|pwsh]\n                                  Install completion for the specified shell.\n  --show-completion [bash|zsh|fish|powershell|pwsh]\n                                  Show completion for the specified shell, to\n                                  copy it or customize the installation.\n  --help                          Show this message and exit.\n\nCommands:\n  create-module      - Scaffolds Ellar Application Module -\n  create-project     - Scaffolds Ellar Application -\n  db\n  runserver          - Starts Uvicorn Server -\n  say-hi\n  whatever-you-want  Whatever you want\n"
+    )
+    result = subprocess.run(
+        ["ellar", "-p", "example_project", "--help"], stdout=subprocess.PIPE
+    )
+    assert result.returncode == 0
+    assert (
+        result.stdout
+        == b"Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -p, --project TEXT              Run Specific Command on a specific project\n  --install-completion [bash|zsh|fish|powershell|pwsh]\n                                  Install completion for the specified shell.\n  --show-completion [bash|zsh|fish|powershell|pwsh]\n                                  Show completion for the specified shell, to\n                                  copy it or customize the installation.\n  --help                          Show this message and exit.\n\nCommands:\n  create-module      - Scaffolds Ellar Application Module -\n  create-project     - Scaffolds Ellar Application -\n  db\n  runserver          - Starts Uvicorn Server -\n  say-hi\n  whatever-you-want  Whatever you want\n"
+    )
+
+    result = subprocess.run(
+        ["ellar", "-p", "example_project_2", "--help"], stdout=subprocess.PIPE
+    )
+    assert result.returncode == 0
+    assert (
+        result.stdout
+        == b"Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -p, --project TEXT              Run Specific Command on a specific project\n  --install-completion [bash|zsh|fish|powershell|pwsh]\n                                  Install completion for the specified shell.\n  --show-completion [bash|zsh|fish|powershell|pwsh]\n                                  Show completion for the specified shell, to\n                                  copy it or customize the installation.\n  --help                          Show this message and exit.\n\nCommands:\n  create-module      - Scaffolds Ellar Application Module -\n  create-project     - Scaffolds Ellar Application -\n  db\n  project-2-command  Project 2 Custom Command\n  runserver          - Starts Uvicorn Server -\n  say-hi\n  whatever-you-want  Whatever you want\n"
+    )