Re-organize file structure

Author: ggeerraarrdd

.gitignore

@@ -64,6 +64,8 @@ db.sqlite3-journal
 # Flask stuff:
 instance/
 .webassets-cache
+flask_session/
+/*_session/
 
 # Scrapy stuff:
 .scrapy
@@ -137,6 +139,7 @@ venv.bak/
 
 # mkdocs documentation
 /site
+/zite
 
 # mypy
 .mypy_cache/
@@ -159,16 +162,5 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-####################################################
-# My adds
-
 # macOS
 .DS_Store
-
-# Flask
-flask_session/
-/*_session/
-
-sketch*
-zketch*
-####################################################

.pylintrc

@@ -0,0 +1,4 @@
+[MESSAGES CONTROL]
+disable=line-too-long
+disable=protected-access
+disable=bare-except

README.md

@@ -27,7 +27,7 @@ As of v3.0.0-beta.1, the following `OUTPUT` types can be requested from exposed
 
 More coming soon!
 
-![Portfoliofy](/images/portfoliofy1.png)
+![Portfoliofy](/docs/portfoliofy1.png)
 
 More screenshots below.
 
@@ -106,7 +106,7 @@ More screenshots below.
 1. **Start the live server**
 
     ```bash
-    uvicorn app.main:app --reload
+    uvicorn api.portfoliofy:app --reload
     ```
 
 2. **Access the documentation user interfaces**
@@ -215,11 +215,11 @@ Improvements and new features development are ongoing.
 
 ## Screenshots
 
-![Portfoliofy](/images/portfoliofy2.png)
+![Portfoliofy](/docs/portfoliofy2.png)
 
-![Portfoliofy](/images/portfoliofy3.png)
+![Portfoliofy](/docs/portfoliofy3.png)
 
-![Portfoliofy](/images/portfoliofy4.png)
+![Portfoliofy](/docs/portfoliofy4.png)
 
 <https://github.com/ggeerraarrdd/portfoliofy/assets/50889794/c93ae299-1e76-42c1-b297-713a923eab79>
 

app/__init__.py renamed to api/__init__.py

@@ -0,0 +1,5 @@
+"""
+TD
+"""
+
+from .config import settings_devices

api/core/config/__init__.py

@@ -1,8 +1,20 @@
-# ################################################## #
+# #########################################################################
 #
-# DO NOT EDIT
+# WARNING: DO NOT MODIFY THIS CONFIG FILE.
 #
-# ################################################## #
+# Manual modifications can cause unintended behavior.
+#
+# #########################################################################
+
+
+
+
+
+
+
+
+
+
 settings_devices = {
     "desktop": {
         "filename_large": "screenshot_desktop_large.png",
@@ -82,4 +94,4 @@
         "height_small": None,
         "small_height_crop": None,
     },
-}
+}

app/settings.py renamed to api/core/config/config.py

@@ -0,0 +1,22 @@
+"""
+TD
+"""
+
+from .utils import get_screenshot
+from .utils import get_screenshot_full
+from .utils import get_screenshot_full_chrome
+from .utils import get_base
+from .utils import get_overlay
+from .utils import get_final_temp
+from .utils import get_final
+from .utils import cleanup
+
+# Define what should be available when using "from .helpers import *"
+__all__ = ['get_screenshot',
+           'get_screenshot_full',
+           'get_screenshot_full_chrome',
+           'get_base',
+           'get_overlay',
+           'get_final_temp',
+           'get_final',
+           'cleanup']

api/core/utils/__init__.py

@@ -1,22 +1,39 @@
-import os
-import json
+"""
+TD
+"""
+
+# Python Standard Libraries
 import base64
+import json
+import os
 from time import sleep
+
+# Third-Party Libraries
+from cairosvg import svg2png
+from PIL import Image
 from selenium import webdriver
 from selenium.webdriver.chrome.service import Service
 from selenium.webdriver.chrome.options import Options
-from PIL import Image
-from cairosvg import svg2png
 
 
-def get_screenshot(url, wait, directory, settings_devices):
 
+
+
+
+
+
+
+
+def get_screenshot(url, wait, directory, settings_devices):
+    """
+    TD
+    """
     # Set options
     options = Options()
     options.add_argument(f"--window-size={settings_devices['width_large']},{settings_devices['height_large']}")
-    options.add_argument(f"--no-sandbox")
-    options.add_argument(f"--headless")
-    options.add_argument(f"--hide-scrollbars")
+    options.add_argument("--no-sandbox")
+    options.add_argument("--headless")
+    options.add_argument("--hide-scrollbars")
 
     try:
         # Set Chromedriver path
@@ -30,7 +47,7 @@ def get_screenshot(url, wait, directory, settings_devices):
 
     # Open Chrome webdriver
     driver = webdriver.Chrome(options=options)
-    
+
     # Take screenshot
     driver.get(url)
     sleep(wait)
@@ -46,11 +63,13 @@ def get_screenshot(url, wait, directory, settings_devices):
 
 
 def get_screenshot_full(url, wait, directory, settings_devices):
-
+    """
+    TD
+    """
     options = Options()
-    options.add_argument(f"--no-sandbox")
-    options.add_argument(f"--headless=new")
-    options.add_argument(f"--hide-scrollbars")
+    options.add_argument("--no-sandbox")
+    options.add_argument("--headless=new")
+    options.add_argument("--hide-scrollbars")
 
     try:
         # Set Chromedriver path
@@ -60,7 +79,7 @@ def get_screenshot_full(url, wait, directory, settings_devices):
         driver = webdriver.Chrome(service=service, options=options)
     except:
         # Open Chrome webdriver
-        driver = webdriver.Chrome(options=options)
+        driver = webdriver.Chrome(options=options) 
 
     # Open Chrome webdriver
     driver = webdriver.Chrome(options=options)
@@ -70,7 +89,7 @@ def get_screenshot_full(url, wait, directory, settings_devices):
     sleep(wait)
 
     fname_out_full_screenshot_png = settings_devices["filename_large"]
-    
+
     png = get_screenshot_full_chrome(driver)
     with open(f"{directory}/{fname_out_full_screenshot_png}", 'wb') as f:
         f.write(png)
@@ -81,8 +100,10 @@ def get_screenshot_full(url, wait, directory, settings_devices):
 
 
 def get_screenshot_full_chrome(driver) :
-
-    # Function adapted from StackOverflow answer 
+    """
+    TD
+    """
+    # Function adapted from StackOverflow answer
     # https://stackoverflow.com/questions/45199076/take-full-page-screenshot-in-chrome-with-selenium/45201692#45201692
 
     def send(cmd, params):
@@ -120,14 +141,16 @@ def evaluate(script):
 
 
 def get_base(post, directory, svg, svg_fname, png_fname):
-
+    """
+    TD
+    """
     # Create SVG file
-    with open(f"{directory}/{svg_fname}", "w") as file:
+    with open(f"{directory}/{svg_fname}", "w", encoding="utf-8") as file:
         file.write(svg)
-    
+
     # Convert to SVG to PNG
-    svg2png(url=f"{directory}/{svg_fname}", 
-            write_to=f"{directory}/{png_fname}", 
+    svg2png(url=f"{directory}/{svg_fname}",
+            write_to=f"{directory}/{png_fname}",
             background_color=post["doc_fill_color"])
 
     # Delete SVG file
@@ -137,12 +160,14 @@ def get_base(post, directory, svg, svg_fname, png_fname):
 
 
 def get_overlay(directory, fname_input, fname_output, new_width, height_crop):
-
+    """
+    TD
+    """
     # Open the PNG image
     image = Image.open(f"{directory}/{fname_input}")
 
     # Determine aspect ratio
-    aspect_ratio = image.height / image.width 
+    aspect_ratio = image.height / image.width
 
     # Set new height
     new_height = int(new_width * aspect_ratio)
@@ -161,7 +186,9 @@ def get_overlay(directory, fname_input, fname_output, new_width, height_crop):
 
 
 def get_final_temp(base, overlay, lat, lng, directory_path, new_file_name):
-
+    """
+    TD
+    """
     # Open the base image
     base_image = Image.open(base)
 
@@ -181,34 +208,37 @@ def get_final_temp(base, overlay, lat, lng, directory_path, new_file_name):
 
 
 def get_final(directory, filename_input, filename_output, post):
-
+    """
+    TD
+    """
     right = post["doc_pad_h"]
     left = post["doc_pad_h"]
     top = post["doc_pad_v"]
     bottom = post["doc_pad_v"]
     color = post["doc_fill_color"]
 
-    image = Image.open(f"{directory}/{filename_input}") 
-    
-    width, height = image.size 
-    
-    new_width = width + right + left 
-    new_height = height + top + bottom 
-    
-    result = Image.new(image.mode, (new_width, new_height), color) 
-    
-    result.paste(image, (left, top)) 
-    
-    result.save(f"{directory}/{filename_output}") 
+    image = Image.open(f"{directory}/{filename_input}")
+
+    width, height = image.size
+
+    new_width = width + right + left
+    new_height = height + top + bottom
+
+    result = Image.new(image.mode, (new_width, new_height), color)
+
+    result.paste(image, (left, top))
+
+    result.save(f"{directory}/{filename_output}")
 
     return 1
 
 
 def cleanup(directory_path, file):
+    """
+    TD
+    """
     try:
         os.remove(f"{directory_path}/{file}")
         return f"{file} has been deleted"
     except FileNotFoundError:
         return f"{file} not in directory"
-    
-    

app/helpers.py renamed to api/core/utils/utils.py

@@ -0,0 +1,5 @@
+"""
+TD
+"""
+
+from .schemas import PortfoliofyRequest

api/domain/schemas/__init__.py

@@ -0,0 +1,29 @@
+"""
+TD
+"""
+
+from pydantic import BaseModel, HttpUrl, constr, conint, Field
+
+
+
+
+
+
+
+
+
+
+class PortfoliofyRequest(BaseModel):
+    """
+    TD
+    """
+    # pylint: disable-all
+    request: bool = Field(False, description='Request flag')
+    remote_url: HttpUrl = Field("https://ggeerraarrdd.github.io/", description="Valid and accessible URL")
+    wait: conint(gt=0, lt=101) = Field(2, description="Wait time for screenshot") # type: ignore[reportInvalidTypeForm]
+    format: str = Field("png", pattern="^(png)$", description="Output file format")
+    doc_pad_h: conint(gt=0, lt=1001) = Field(300, description="Padding value for horizontal dimension") # type: ignore[reportInvalidTypeForm]
+    doc_pad_v: conint(gt=0, lt=1001) = Field(200, description="Padding value for vertical dimension") # type: ignore[reportInvalidTypeForm]
+    doc_fill_color: constr(pattern=r"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$") = Field("#ffffff", description="RGB hexadecimal value") # type: ignore[reportInvalidTypeForm]
+    base_stroke_color: constr(pattern=r"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$") = Field("#23445d", description="RGB hexadecimal value") # type: ignore[reportInvalidTypeForm]
+    base_fill_color: constr(pattern=r"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$") = Field("#bac8d3", description="RGB hexadecimal value") # type: ignore[reportInvalidTypeForm]