Merge pull request #31 from eadwinCode/cli_help_command_fix

Cli help command fix

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

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

docs/quick-start.md

@@ -29,12 +29,14 @@ pip install ellar
 ## Create a project
 To create an ellar project, you need to have a `pyproject.toml` available on your root directory.
 This is necessary for ellar to store some `metadata` about your project. 
+
 ### Step 1
 For Pip Users, you need to create `pyproject.toml` file
 ```shell
 touch pyproject.toml
 ```
 If you are using `Poetry`, you are ready to go
+
 ### Step 2
 Run the ellar create project cli command,
 ```shell
@@ -51,6 +53,7 @@ ellar runserver --reload
 Now go to [http://127.0.0.1:8000](http://127.0.0.1:8000)
 ![Swagger UI](img/ellar_framework.png)
 
+
 ## Create a project module
 A project module is a project app defining a group of controllers or services including templates and static files.
 So, now we have a project created, lets add an app to the project.
@@ -59,7 +62,7 @@ ellar create-module car
 ```
 
 ## Add Schema
-In `car.schema.py`, lets add some serializer for car input and output data
+In `car/schema.py`, lets add some serializer for car input and output data
 ```python
 from ellar.serializer import Serializer
 
@@ -74,7 +77,7 @@ class RetrieveCarSerializer(CarSerializer):
 ```
 
 ## Add Services
-In `car.services.py`, lets create a dummy repository `CarDummyDB` to manage our car data.
+In `car/services.py`, lets create a dummy repository `CarDummyDB` to manage our car data.
 ```python
 import typing as t
 import uuid
@@ -127,7 +130,7 @@ class CarDummyDB:
             return self._data.pop(idx)
 ```
 ## Add Controller
-In `car.controllers.py`, lets create `CarController`
+In `car/controllers.py`, lets create `CarController`
 
 ```python
 import typing as t
@@ -175,7 +178,7 @@ class CarController(ControllerBase):
 
 ```
 ## Register Service and Controller
-In `car.module.py`, lets register `CarController` and `CarDummyDB`
+In `car/module.py`, lets register `CarController` and `CarDummyDB`
 
 ```python
 from ellar.common import Module
@@ -198,9 +201,27 @@ class CarModule(ModuleBase):
         pass
 ```
 
+## Registering Module
+Ellar is not aware of `CarModule` yet, so we need to add it to the `modules` list of `ApplicationModule` at the `carsite/root_module.py`.
+```python
+from ellar.common import Module, exception_handler
+from ellar.core import ModuleBase
+from ellar.core.connection import Request
+from ellar.core.response import JSONResponse, Response
 
-## Enabling OpenAPI
-To start up openapi, we need to go back to project folder in the `carsite.server.py`
+from ellar.samples.modules import HomeModule
+from .apps.car.module import CarModule
+
+
+@Module(modules=[HomeModule, CarModule])
+class ApplicationModule(ModuleBase):
+    @exception_handler(404)
+    def exception_404_handler(cls, request: Request, exc: Exception) -> Response:
+        return JSONResponse(dict(detail="Resource not found."))
+
+```
+## Enabling OpenAPI Docs
+To start up openapi, we need to go back to project folder in the `server.py`
 then add the following below.
 ```python
 import os

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"
+    )