chore: update project structure (#2)

* chore: rename compose directory to docker
* chore: add CLI commands for test, format and linting
* chore: update readme file

Author: miguel-osuna

Pipfile

@@ -34,7 +34,10 @@ apispec-webframeworks = "==0.5.2"
 gunicorn = "==20.0.4"
 zappa = "==0.52.0"
 
-[script]
+[scripts]
+format = "python3 cli/format.py quotes_api tests"
+lint = "python3 cli/lint.py quotes_api"
+test = "python3 cli/test.py tests"
 
 [requires]
 python_version = "3.8"

README.md

@@ -47,6 +47,15 @@ Make sure to create a hidden folder like `envs.example` named `.envs`, with the
 docker-compose up -f local.yml up -d --build
 ```
 
+## Commands 
+The project supports cli commands for formatting, linting, database initialization and more. 
+
+| **Action** |    **Command**    |
+| :--------: | :---------------: |
+|    Test    |  pipenv run test  |
+|   Format   | pipenv run format |
+|    Lint    |  pipenv run lint  |
+
 ## :rocket: Deployment
 This project includes configuration files for both Heroku and AWS using Zappa.
 

cli/__init__.py

@@ -0,0 +1,25 @@
+"""Quotes API CLI Initialization."""
+import importlib
+import os
+
+
+def register_cli_commands(app):
+    """
+    Register 0 or more Flask CLI commands (mutates the app passed in).
+
+    :param app: Flask application instance
+    :return: None
+    """
+    for file in os.listdir(os.path.dirname(__file__)):
+        if file.startswith("flask_") and file.endswith(".py"):
+            # Get the file name
+            file_name = file[:-3]
+            command_name = file[4:-3]
+
+            # Import the cli command module
+            module = importlib.import_module(f"cli.{file_name}")
+
+            command = getattr(module, command_name)
+
+            # Register the cli command under the Flask app
+            app.cli.add_command(command)

cli/format.py

@@ -0,0 +1,21 @@
+"""Formating (Black) CLI Command"""
+import subprocess
+
+import click
+
+
+@click.command()
+@click.argument("path", default=".")
+def format(path):
+    """
+    Run black code formatter on the codebase.
+
+    :param path: Execution path
+    :return: Subprocess call result
+    """
+    command = f"black {path}"
+    return subprocess.call(command, shell=True)
+
+
+if __name__ == "__main__":
+    format()

cli/lint.py

@@ -0,0 +1,21 @@
+"""Linter (Pylint) CLI Command"""
+import subprocess
+
+import click
+
+
+@click.command()
+@click.argument("path", default="quots_api")
+def lint(path):
+    """
+    Run pylint linter to analyze the codebase.
+
+    :param path: Execution path
+    :return: Subprocess call result
+    """
+    command = f"pylint {path}"
+    return subprocess.call(command, shell=True)
+
+
+if __name__ == "__main__":
+    lint()

cli/test.py

@@ -0,0 +1,17 @@
+"""Test (Pytest) CLI Command"""
+import subprocess
+
+import click
+
+
+@click.command()
+@click.argument("path", default="tests")
+def test(path):
+    """
+    Run tests with Pytest.
+
+    :param path: Test path
+    :return: Subprocess call result
+    """
+    command = f"pytest -s {path}"
+    return subprocess.call(command, shell=True)

compose/local/application/Dockerfile renamed to docker/local/application/Dockerfile

@@ -32,7 +32,7 @@ RUN pip install pipenv
 RUN pipenv install --ignore-pipfile --system && pipenv install --ignore-pipfile --dev --system
 
 # Copy start bash script ahd change permissions
-COPY ./compose/local/application/start /start
+COPY ./docker/local/application/start /start
 RUN sed -i 's/\r$//g' /start 
 RUN chmod +x /start 
 

compose/local/application/start renamed to docker/local/application/start

@@ -32,7 +32,7 @@ RUN pip install pipenv
 RUN pipenv install --ignore-pipfile --system && pipenv install --ignore-pipfile --dev --system
 
 # Copy start bash script ahd change permissions
-COPY ./compose/production/application/start /start
+COPY ./docker/production/application/start /start
 RUN sed -i 's/\r$//g' /start 
 RUN chmod +x /start 
 

compose/production/application/Dockerfile renamed to docker/production/application/Dockerfile

@@ -4,7 +4,7 @@ services:
   application:
     build:
       context: .
-      dockerfile: ./compose/local/application/Dockerfile
+      dockerfile: ./docker/local/application/Dockerfile
     image: quotes_api_local
     container_name: quotes_api
     depends_on:

compose/production/application/start renamed to docker/production/application/start

@@ -4,7 +4,7 @@ services:
   application:
     build:
       context: .
-      dockerfile: ./compose/production/application/Dockerfile
+      dockerfile: ./docker/production/application/Dockerfile
     image: quotes_api_production
     container_name: quotes_api
     volumes:

local.yml

@@ -8,8 +8,8 @@
 
 
 class AuthorList(Resource):
-    """ List of quote authors. 
-    
+    """List of quote authors.
+
     ---
     get:
       tags:
@@ -22,7 +22,7 @@ class AuthorList(Resource):
       parameters:
         - in: query
           name: page
-          schema: 
+          schema:
             type: integer
             default: 1
           description: Page number of the pagination.
@@ -38,7 +38,7 @@ class AuthorList(Resource):
             type: string
             enum: [asc, desc]
             default: asc
-          description: Author's name sort order. 
+          description: Author's name sort order.
       responses:
         200:
           content:
@@ -64,7 +64,7 @@ class AuthorList(Resource):
 
     @role_required([Role.BASIC, Role.ADMIN])
     def get(self):
-        """ Get quote authors by alphabetical order. """
+        """Get quote authors by alphabetical order."""
 
         args = request.args
         page = int(args.get("page", 1))
@@ -94,7 +94,7 @@ def get(self):
             )
 
     def sort_order_parser(self, input):
-        """ 
+        """
         Parses a user query input for the sort_order parameter.
 
         Checks if the sorting is ascending or descending.