Basic cli (#5)

* basic create and serve project cli

* tweak cli

Author: zachspar

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "FireFrame"
-version = "0.0.0-alpha.9"
+version = "0.0.0-alpha.10"
 authors = [
   { name="Zachary Spar", email="[email protected]" },
 ]

src/fireframe/cli/__init__.py

@@ -2,4 +2,4 @@
 
 from .project import project_cli
 
-cli = click.CommandCollection(sources=[project_cli])
+cli = project_cli()

src/fireframe/cli/project.py

@@ -12,9 +12,12 @@ def project_cli(ctx):
 
 @project_cli.command()
 @click.argument("name", required=True, type=str)
-@click.option("--path", "-p", type=click.Path())
+@click.option("--path", "-p", type=click.Path(), help="The path to create the project in.")
 @click.pass_context
 def create(ctx, name: str, path):
+    """
+    Create a new FireFrame project scaffold.
+    """
     click.echo(f"Creating new project {name}...")
     # create a new subdirectory to path if given,
     # otherwise create a new subdirectory to current working directory
@@ -25,10 +28,73 @@ def create(ctx, name: str, path):
     elif not os.path.exists(name):
         os.makedirs(os.path.join(os.getcwd(), name))
 
+    # NOTE: We should probably use proper templates for these files
+    # create a file called main.py in the new project directory
+    with open(os.path.join(os.getcwd(), name, "main.py"), "w") as f:
+        f.write(f"# Path: {name}/main.py\n\n")
+        f.write(f"from fireframe.core.api import FireFrameAPI\n")
+        f.write(f"from fireframe.core.viewsets import crud_viewset\n\n")
+        f.write(f"from serializers import Example{name.capitalize()}Serializer\n")
+        f.write(f"from views import Example{name.capitalize()}ListAPIView\n\n")
+        f.write(f'app = FireFrameAPI(name="{name}", version="0.0.0")\n\n')
+        f.write(f"# TODO: Add your routes here\n")
+        f.write(f"app.include_router(crud_viewset(Example{name.capitalize()}Serializer))\n")
+        f.write(f"app.include_router(Example{name.capitalize()}ListAPIView())\n")
+
+    # create a file called models.py in the new project directory
+    with open(os.path.join(os.getcwd(), name, "models.py"), "w") as f:
+        f.write(f"# Path: {name}/models.py\n\n")
+        f.write(f"from fireframe.core.models import Model\n\n")
+        f.write(f"class Example{name.capitalize()}Model(Model):\n")
+        f.write(f"    example: str\n\n")
+        f.write(f"# TODO: Add more models here\n")
+
+    # create a file called serializers.py in the new project directory
+    with open(os.path.join(os.getcwd(), name, "serializers.py"), "w") as f:
+        f.write(f"# Path: {name}/serializers.py\n\n")
+        f.write("from fireframe.core.serializers import ModelSerializer\n\n")
+        f.write(f"from models import Example{name.capitalize()}Model\n\n")
+        f.write(f"class Example{name.capitalize()}Serializer(ModelSerializer):\n")
+        f.write(f"    class Meta:\n")
+        f.write(f"        model = Example{name.capitalize()}Model\n")
+        f.write(f'        fields = ["example"]\n\n')
+        f.write(f"# TODO: Add more serializers here\n")
+
+    # create a file called views.py in the new project directory
+    with open(os.path.join(os.getcwd(), name, "views.py"), "w") as f:
+        f.write(f"# Path: {name}/views.py\n\n")
+        f.write("from fireframe.core.views import BaseListAPIView\n\n")
+        f.write(f"from serializers import Example{name.capitalize()}Serializer\n\n")
+        f.write(f"class Example{name.capitalize()}ListAPIView(BaseListAPIView):\n")
+        f.write(f"    serializer_class = Example{name.capitalize()}Serializer\n\n")
+        f.write(f"# TODO: Add more views here\n")
+
 
 @project_cli.command()
-@click.argument("name", required=True, type=str)
+@click.option(
+    "--entrypoint", "-e", type=str, default="main:app", help="The entrypoint of the project as specified by uvicorn."
+)
+@click.option("--port", "-p", type=int, default=8000, help="The port to run the project on.")
 @click.pass_context
-def startapp(ctx, name: str):
-    click.echo(f"Starting new app {name}...")
-    raise NotImplementedError("Implement project startapp.")
+def serve(ctx, entrypoint: str, port: int):
+    """
+    Run the FireFrame project.
+    """
+    click.echo(f"Running FireFrame project on port {port}  ...")
+    # check if uvicorn is installed via pip
+    try:
+        import uvicorn
+    except ImportError:
+        click.echo("Uvicorn is not installed. Installing it via pip.")
+        os.system("pip install uvicorn")
+
+    # check if the project has a main.py file
+    if not os.path.exists(os.path.join(os.getcwd(), f"{entrypoint.split(':')[0]}.py")):
+        click.echo("No main.py file found. Please run this command from the root directory of your project.")
+        click.echo(
+            "If you have renamed your main.py file, please specify the new entrypoint with the --entrypoint flag."
+        )
+        return
+
+    # run the project with uvicorn in background
+    os.system(f"uvicorn {entrypoint} --reload --port {port} --host '0.0.0.0'")