Adding Makefile and updating CI

.github/workflows/ci.yaml

@@ -24,11 +24,15 @@ jobs:
           python-version: 3.8.5
       - name: Generate coverage report
         run: |
-          pip install -r requirements.txt
-          pytest --cov cold_silence --cov-report=xml
+          make setup
+          make install
+          make test
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
           verbose: true
+      - name: Clean up
+        run: |
+          make clean

COPYING

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,24 @@
+clean:
+	rm -rf project_output
+	rm -f .coverage
+	rm -f coverage.xml
+	rm -rf .pytest_cache
+
+test:
+	pytest --cov cold_silence --cov-report=xml
+
+test_clean:
+	make test
+	make clean
+
+build_default_project:
+	python3 src/cold_silence/main.py
+
+setup:
+	pip install -r requirements.txt
+
+format:
+	black ./
+
+install:
+	pip install .

README.md

@@ -6,15 +6,35 @@
 
 Start a new Django project sans boilerplate code.
 
+# Setup
+
+```bash
+cd [project_dir]
+pip install .
+cd [project_dir]/src/cold_silence
+pip install -r requirements.txt
+
+OR
+
+cd [project_dir]
+make install
+make setup
+```
+
 # Quickstart
 
 ```bash
-cd src
+cd [project_dir]/src/cold_silence
 python3 main.py
+
+OR
+
+cd [project_dir]
+make build_default_project
 ```
 
 ```bash
-cd src
+cd [project_dir]/src/cold_silence
 python3 main.py --server_port 8080 --project_name my_project --service_name my_service --project_directory my_project --verbose
 ```
 
@@ -42,6 +62,23 @@ python3 main.py --server_port 8080 --project_name my_project --service_name my_s
 │   └── staging.env
 ```
 
+# Testing
+
+To run tests, run the following
+
+```bash
+cd [project_dir]
+pytest --cov cold_silence --cov-report=xml
+
+OR
+
+make test # This will generate several artifacts, along with a project, which can be removed with make clean
+
+OR
+
+make test_clean # This will automatically remove the generated artifacts and generated project
+```
+
 # Info
 
 Python Version: 3.8.5

src/cold_silence/main.py

@@ -4,26 +4,24 @@
 from cold_silence.nginx_gen import NginxGen
 from pathlib import Path
 from cold_silence.settings_gen import SettingsGen
+from cold_silence.requirements_gen import RequirementsGen
 from subprocess import Popen as pop
 from cold_silence.utils import (
     DEFAULT_PATH,
     DEFAULT_SERVICE_NAME,
     DEFAULT_SERVER_PORT,
     DEFAULT_PROJECT_NAME,
     DEFAULT_PROJECT_DIRECTORY,
+    DEFAULT_CONFIG,
+    ENGINE_SQLITE3,
+    verify_or_install_django,
+    verify_or_install_gunicorn,
+    verify_or_install_rest_framework,
+    verify_or_install_black,
 )
 import argparse
-import pip
 import sys
 
-
-def __verify_django_version():
-    import django
-
-    version = django.__version__
-    print("Proceeding using Django version: " + version)
-
-
 def __print_message(message, verbose):
     if verbose:
         print(message)
@@ -38,7 +36,7 @@ def __end_gen_message(message, verbose):
 
 
 def parse_args(args):
-    print(args)
+
     parser = argparse.ArgumentParser()
 
     parser.add_argument(
@@ -65,6 +63,18 @@ def parse_args(args):
         type=str,
     )
 
+    parser.add_argument(
+        "--engine",
+        help="Database to use for the project, the default is sqlite.",
+        type=str,
+    )
+
+    parser.add_argument(
+        "--rest_api",
+        help="Generate a REST API starter, by default this is disabled",
+        action="store_true",
+    )
+
     parser.add_argument("--verbose", help="Display verbose output", action="store_true")
 
     args = parser.parse_args(args)
@@ -85,40 +95,38 @@ def parse_args(args):
         else DEFAULT_PROJECT_DIRECTORY
     )
 
+    rest_api = args.rest_api if args.rest_api is not None else False
+
+    engine = args.engine if args.engine is not None else ENGINE_SQLITE3
+
     verbose = args.verbose
 
     return {
+        "engine": engine,
         "path": path,
-        "service_name": service_name,
-        "server_port": server_port,
-        "project_name": project_name,
         "project_directory": project_directory,
+        "project_name": project_name,
+        "rest_api": rest_api,
+        "server_port": server_port,
+        "service_name": service_name,
         "verbose": verbose,
     }
 
 
-def generate_project(
-    path=DEFAULT_PATH,
-    service_name=DEFAULT_SERVICE_NAME,
-    server_port=DEFAULT_SERVER_PORT,
-    project_name=DEFAULT_PROJECT_NAME,
-    project_directory=DEFAULT_PROJECT_DIRECTORY,
-    verbose=False,
-):
-    try:
-        __verify_django_version()
-    except Exception as e:
-        try:
-            print(
-                "Can't find Django, attempting to install using `python3 -m pip install django`..."
-            )
-
-            pip.main(["install", "django"])
-            __verify_django_version()
-        except Exception as e:
-            print("Unable to install Django, install Django before proceeding.")
-            exit(1)
-    out_path = path
+def generate_project(config=DEFAULT_CONFIG):
+    verify_or_install_django()
+    verify_or_install_gunicorn()
+    verify_or_install_rest_framework()
+    verify_or_install_black()
+
+    engine = config.get("engine", ENGINE_SQLITE3)
+    out_path = config.get("path", DEFAULT_PATH)
+    project_directory = config.get("project_directory", DEFAULT_PROJECT_DIRECTORY)
+    project_name = config.get("project_name", DEFAULT_PROJECT_NAME)
+    rest_api = config.get("rest_api", False)
+    server_port = config.get("server_port", DEFAULT_SERVER_PORT)
+    service_name = config.get("service_name", DEFAULT_SERVICE_NAME)
+    verbose = config.get("verbose", False)
 
     __print_message("Creating directory " + out_path + " ...", verbose=verbose)
 
@@ -131,7 +139,7 @@ def generate_project(
     __print_message(out_path + " created!", verbose=verbose)
 
     __begin_gen_message(
-        "Django project " + project_name + " in " + out_path, verbose=verbose
+        "django project " + project_name + " in " + out_path, verbose=verbose
     )
 
     try:
@@ -143,44 +151,53 @@ def generate_project(
         # https://stackoverflow.com/a/2837319
         op.communicate()
     except Exception as e:
-        print(e)
-        exit(1)
+        raise e
 
-    __end_gen_message("Django project " + project_name, verbose=verbose)
+    __end_gen_message("django project " + project_name, verbose=verbose)
 
-    # Get inside the Django project's main directory
+    # Get inside the django project's main directory
     settings_path = out_path + "/" + project_name + "/" + project_name
 
     __begin_gen_message("Settings file", verbose=verbose)
 
-    SettingsGen().generate_settings_file(path=settings_path)
+    SettingsGen().generate_settings_file(
+        path=settings_path, project_name=project_name, engine=engine, rest_api=rest_api
+    )
 
     __end_gen_message("Settings file", verbose=verbose)
 
+    __begin_gen_message("Requirements file", verbose=verbose)
+
+    RequirementsGen().generate_requirements_file(
+        path=out_path, project_directory=project_directory
+    )
+
+    __end_gen_message("Requirements file", verbose=verbose)
+
     __begin_gen_message("Environment variable files", verbose=verbose)
 
-    EnvGen().generate_all_env_files(path=path)
+    EnvGen().generate_all_env_files(path=out_path)
 
     __end_gen_message("Environment variable files", verbose=verbose)
 
     __begin_gen_message("Git ignore file", verbose=verbose)
 
-    GitIgnoreGen().generate_gitignore_file(path=path)
+    GitIgnoreGen().generate_gitignore_file(path=out_path)
 
     __end_gen_message("Git ignore file", verbose=verbose)
 
     __begin_gen_message("Nginx files", verbose=verbose)
 
     NginxGen().generate_nginx_files(
-        path=path, server_port=server_port, service_name=service_name
+        path=out_path, server_port=server_port, service_name=service_name
     )
 
     __end_gen_message("Nginx files", verbose=verbose)
 
     __begin_gen_message("Dockerfiles and docker-compose files", verbose=verbose)
 
     DockerGen().generate_docker_files(
-        path=path,
+        path=out_path,
         project_directory=project_directory,
         project_name=project_name,
         server_port=server_port,
@@ -189,21 +206,25 @@ def generate_project(
 
     __end_gen_message("Dockerfiles and docker-compose files", verbose=verbose)
 
+    try:
+        op = pop(
+            ["/usr/bin/python3", "-m", "black", "."],
+            shell=False,
+            cwd=out_path,
+        )
+        # https://stackoverflow.com/a/2837319
+        op.communicate()
+    except Exception as e:
+        raise e
+
     print("Project generation complete, you're ready to get started!")
     print("Happy programming!")
 
 
 def main():
-    args = parse_args(sys.argv[1:])
+    config = parse_args(sys.argv[1:])
 
-    generate_project(
-        path=args["path"],
-        service_name=args["service_name"],
-        server_port=args["server_port"],
-        project_name=args["project_name"],
-        project_directory=args["project_directory"],
-        verbose=args["verbose"],
-    )
+    generate_project(config=config)
 
 
 if __name__ == "__main__":