rebuilt new version

MurphyAdam · MurphyAdam · commit 8c71535b9f82 · 2021-01-04T15:30:32.000+01:00
diff --git a/build/lib/kickstart_flask_app/core.py b/build/lib/kickstart_flask_app/core.py
@@ -12,26 +12,34 @@
     main_bp_init_template,
     requirements_template, 
     config_template,
-    runtime_template)
+    runtime_template,
+    html_index,
+    style_css)
 
 class KickstartFlaskApp():
 
     def __init__(self):
         self.project_name: str = 'Hello-Flask'
         self.root_app_name: str = 'server'
         self.app_version: float = 1.0
-        self.description: str = ''
+        self.description: str = (f'This is a simple Flask app initiated with '
+                                f'kickstart-flask-app Python package')
         self.author: str = getuser()
         self.main_bp_name: str = 'main_bp'
-        self.setup_heroku_deployment_files: str = 'yes'
+        self.setup_heroku_deployment_files_check: str = 'yes'
+        self.setup_flask_templates_and_static_files_check: str = 'yes'
         self.fields_names = [f'Project name. Default ({self.project_name})', 
             f'Root app name. Default ({self.root_app_name})', 
             f'App version. Default ({self.app_version})', 
             f'Description. Default ({self.description})', 
             f'Author. Default ({self.author})', 
             f'Main Blueprint name. Default ({self.main_bp_name})', 
-            f'Setup Heroku deployment files. Default ({self.setup_heroku_deployment_files})']
+            f'Setup Heroku deployment files. Default ({self.setup_heroku_deployment_files_check})']
         self.runtime: str = ".".join(map(str, version_info[:3]))
+
+        """
+        Main files to run the app
+        """
         self.flask_files = ['wsgi.py', 
             '__init__.py', 
             'routes.py', 
@@ -40,14 +48,27 @@ def __init__(self):
             'tests.py', 
             'requirement.txt'
         ]
-        self.flask_files_paths = []
-        self.flask_files_templates = []
+        self.flask_files_paths: dict = []
+        self.flask_files_templates: dict = []
+
+        """
+        Flask directories: templates and static
+        """
+        self.flask_dirs: dict = ['templates', 
+            'static'
+        ]
+        self.flask_dirs_paths: dict = []
+        self.flask_dirs_files: dict = ['index.html', 'style.css']
+        self.flask_dirs_templates: dict = []
 
+        """
+        Required files to deploy the application to Heroku
+        """
         self.heroku_files = ['runtime.txt', 'Procfile']
         self.heroku_files_paths = []
         self.heroku_files_templates = []
 
-    def get_input(self, input_msg, default=None):
+    def get_input(self, input_msg, default=None) -> str:
         if version_info >= (3, 0):
             input_value = input(f'{input_msg}: ')
         else:
@@ -59,7 +80,8 @@ def get_input(self, input_msg, default=None):
 
 
     def write_content(self, file, content, path) -> None:
-        with open(f'{path}/{file}', 'w') as file:
+        file_path = os.path.join(path, file)
+        with open(file_path, 'w') as file:
             if version_info >= (3, 0):
                 file.write(content)
             else:
@@ -75,13 +97,22 @@ def populate_project_files(self) -> None:
             self.flask_files_templates):
             self.write_content(flask_file, flask_file_template, flask_file_path)
 
+    def setup_flask_templates_and_static_files(self) -> None:
+        for flask_dir, flask_dir_path, flask_dir_file, flask_dir_template in zip(self.flask_dirs, 
+            self.flask_dirs_paths,
+            self.flask_dirs_files,
+            self.flask_dirs_templates):
+            full_dir_path = os.path.join(flask_dir_path, flask_dir)
+            os.makedirs(full_dir_path, exist_ok=True)
+            self.write_content(flask_dir_file, flask_dir_template, full_dir_path)
+
     def setup_heroku_files(self) -> None:
         for heroku_file, heroku_file_path, heroku_file_template in zip(self.heroku_files, 
             self.heroku_files_paths,
             self.heroku_files_templates):
             self.write_content(heroku_file, heroku_file_template, heroku_file_path)
 
-    def main(self):
+    def main(self) -> None:
 
         self.project_name = self.get_input(f'Project name. Default ({self.project_name})', 
             default=self.project_name)
@@ -95,10 +126,15 @@ def main(self):
             default=self.author)
         self.main_bp_name = self.get_input(f'Main Blueprint name. Default ({self.main_bp_name})', 
             default=self.main_bp_name)
-        self.setup_heroku_deployment_files = self.get_input(f'Setup Heroku deployment files (yes/no). Default ({self.setup_heroku_deployment_files})', 
-            default=self.setup_heroku_deployment_files)
+        self.setup_heroku_deployment_files_check = self.get_input(
+            (
+                f'Setup Heroku deployment files (yes/no). Default' 
+                f'({self.setup_heroku_deployment_files_check})'
+            ), 
+            default=self.setup_heroku_deployment_files_check)
         
-        self.flask_files_paths = [f'{self.project_name}', 
+        self.flask_files_paths = [
+            f'{self.project_name}', 
             f'{self.project_name}/{self.root_app_name}', 
             f'{self.project_name}/{self.root_app_name}/{self.main_bp_name}', 
             f'{self.project_name}/{self.root_app_name}/{self.main_bp_name}', 
@@ -107,25 +143,44 @@ def main(self):
             f'{self.project_name}'
         ]
 
-        self.flask_files_templates = [wsgi_template.substitute(app_name=self.root_app_name), 
-            app_init_template.substitute(app_name=self.root_app_name, main_bp_name=self.main_bp_name) , 
-            main_bp_routes_template.substitute(app_name=self.root_app_name, main_bp_name=self.main_bp_name), 
-            main_bp_init_template.substitute(app_name=self.root_app_name, main_bp_name=self.main_bp_name), 
-            config_template.substitute(app_name=self.root_app_name, project_name=self.project_name, runtime=self.runtime), 
+        self.flask_files_templates = [
+            wsgi_template.substitute(app_name=self.root_app_name), 
+            app_init_template.substitute(app_name=self.root_app_name, 
+                main_bp_name=self.main_bp_name) , 
+            main_bp_routes_template.substitute(app_name=self.root_app_name, 
+                main_bp_name=self.main_bp_name), 
+            main_bp_init_template.substitute(app_name=self.root_app_name, 
+                main_bp_name=self.main_bp_name), 
+            config_template.substitute(app_name=self.root_app_name, 
+                project_name=self.project_name, runtime=self.runtime, 
+                description=self.description), 
             tests_template.substitute(), 
             requirements_template.substitute()
         ]
 
         self.create_project_structure()
         self.populate_project_files()
 
-        if 'y'.lower() in self.setup_heroku_deployment_files:
+        # setup Heroku files if (y)es
+        if 'y'.lower() in self.setup_heroku_deployment_files_check:
             self.heroku_files_paths = [f'{self.project_name}'] * len(self.heroku_files)
-            self.heroku_files_templates = [runtime_template.substitute(runtime=self.runtime), 
+            self.heroku_files_templates = [
+                runtime_template.substitute(runtime=self.runtime), 
                 procfile_template.substitute()
             ]
             self.setup_heroku_files()
 
+        # setup Flask templates and static dirs and files if (y)es
+        if 'y'.lower() in self.setup_flask_templates_and_static_files_check:
+            self.flask_dirs_paths = [
+                    f'{self.project_name}/{self.root_app_name}'
+                ] * len(self.flask_dirs)
+            self.flask_dirs_templates = [
+                html_index.substitute(project_name=self.project_name, description=self.description), 
+                style_css.substitute()
+            ]
+            self.setup_flask_templates_and_static_files()
+
 def console() -> None:
     kickstart_flask_app = KickstartFlaskApp()
     kickstart_flask_app.main()
diff --git a/build/lib/kickstart_flask_app/templates.py b/build/lib/kickstart_flask_app/templates.py
@@ -71,11 +71,21 @@ def create_app(config_class=config_class()):
     """))
 
 main_bp_routes_template = Template(dedent("""\
+    from datetime import datetime
     from ${app_name}.${main_bp_name} import ${main_bp_name}
+    from flask import jsonify, render_template
+
+    @${main_bp_name}.route('/api')
+    def api():
+        data = {
+            'message': 'Hello world!',
+            'timestamp': datetime.utcnow()
+        }
+        return jsonify(data), 200
 
     @${main_bp_name}.route('/')
-    def Hello():
-        return 'Hello world!', 200
+    def index():
+        return render_template('index.html')
 
     """))
 
@@ -113,6 +123,7 @@ class Config(object):
         PROJECT_NAME = '${project_name}'
         APP_NAME = '${app_name}'
         APP_RUNTIME = '${runtime}'
+        APP_DESCRIPTION = '${description}'
 
         '''
         Environment variabbles
@@ -148,6 +159,59 @@ class Development(Config):
 
     """))
 
+html_index = Template(dedent("""\
+    <!DOCTYPE html>
+    <html>
+        <head>
+            <title>${project_name}</title>
+            <link rel="stylesheet" type="text/css" href="{{url_for('static', filename='style.css', _external=True)}}">
+        </head>
+        <body>
+            <h1>${project_name}</h1>
+            <p>${description}</p>
+            <p>
+                <a href="https://github.com/MurphyAdam/kickstart-flask-app" 
+                    alt="Github repository for kickstart-flask-app package">Github repository
+                </a>
+            </p>
+        </body>
+    </html>
+    """))
+
+style_css = Template(dedent("""\
+    html,
+    body {
+        font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
+        font-size: 14px;
+    }
+
+    body {
+        background: #fafafa;
+        overflow-x: hidden;
+    }
+
+    h1 {
+        color: #4db6ac;
+        display: flex;
+        justify-content: center;
+    }
+
+    p {
+        margin: 2rem;
+        padding: 1rem;
+        display: flex;
+        justify-content: center;
+        font-size: xx-large;
+    }
+    a {
+        color: #4db6ac;
+        text-decoration: none;
+        display: flex;
+        justify-content: center;
+        font-size: 1.5rem;
+    }
+    """))
+
 bashrc_template = Template(dedent("""\
     EXPORT FLASK_ENV='development'
     EXPORT FLASK_APP='development'
diff --git a/dist/kickstart_flask_app-1.1.4-py3-none-any.whl b/dist/kickstart_flask_app-1.1.4-py3-none-any.whl
diff --git a/kickstart_flask_app.egg-info/PKG-INFO b/kickstart_flask_app.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: kickstart-flask-app
-Version: 1.1.4
+Version: 1.1.5
 Summary: Generate a new Flask app project.
 Home-page: https://github.com/MurphyAdam/kickstart-flask-app
 Author: Majdi Mahfoud
diff --git a/kickstart_flask_app.egg-info/SOURCES.txt b/kickstart_flask_app.egg-info/SOURCES.txt
@@ -8,4 +8,5 @@ kickstart_flask_app.egg-info/SOURCES.txt
 kickstart_flask_app.egg-info/dependency_links.txt
 kickstart_flask_app.egg-info/entry_points.txt
 kickstart_flask_app.egg-info/not-zip-safe
+kickstart_flask_app.egg-info/requires.txt
 kickstart_flask_app.egg-info/top_level.txt
