platzky 0.3.6__tar.gz → 0.4.3__tar.gz

{platzky-0.3.6 → platzky-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: platzky
-Version: 0.3.6
+Version: 0.4.3
 Summary: Not only blog engine
 License: MIT
 Requires-Python: >=3.10,<4.0
@@ -10,6 +10,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: Flask (==3.0.3)
 Requires-Dist: Flask-Babel (>=4.0.0,<5.0.0)
 Requires-Dist: Flask-Minify (>=0.42,<0.43)
@@ -22,6 +23,7 @@ Requires-Dist: gql (>=3.4.0,<4.0.0)
 Requires-Dist: humanize (>=4.9.0,<5.0.0)
 Requires-Dist: pydantic (>=2.7.1,<3.0.0)
 Requires-Dist: pygithub (>=2.6.1,<3.0.0)
+Requires-Dist: pymongo (>=4.7.0,<5.0.0)
 Description-Content-Type: text/markdown
 
 ![Github Actions](https://github.com/platzky/platzky/actions/workflows/tests.yml/badge.svg?event=push&branch=main)

{platzky-0.3.6 → platzky-0.4.3}/platzky/db/db.py

@@ -4,7 +4,7 @@ from typing import Any, Callable
 
 from pydantic import BaseModel, Field
 
-from platzky.models import Color, MenuItem, Page, Post
+from platzky.models import MenuItem, Page, Post
 
 
 class DB(ABC):
@@ -81,11 +81,11 @@ class DB(ABC):
         pass
 
     @abstractmethod
-    def get_primary_color(self) -> Color:
+    def get_primary_color(self) -> str:
         pass
 
     @abstractmethod
-    def get_secondary_color(self) -> Color:
+    def get_secondary_color(self) -> str:
         pass
 
     @abstractmethod
@@ -96,6 +96,15 @@ class DB(ABC):
     def get_font(self) -> str:
         pass
 
+    @abstractmethod
+    def health_check(self) -> None:
+        """Perform a health check on the database.
+
+        Should raise an exception if the database is not healthy.
+        This should be a lightweight operation suitable for health checks.
+        """
+        pass
+
 
 class DBConfig(BaseModel):
     type: str = Field(alias="TYPE")

{platzky-0.3.6 → platzky-0.4.3}/platzky/db/graph_ql_db.py

@@ -7,7 +7,7 @@ from gql.transport.exceptions import TransportQueryError
 from pydantic import Field
 
 from platzky.db.db import DB, DBConfig
-from platzky.models import Color, Post
+from platzky.models import Post
 
 
 def db_config_type():
@@ -289,11 +289,11 @@ class GraphQL(DB):
 
         return self.client.execute(favicon)["favicons"][0]["favicon"]["url"]
 
-    def get_primary_color(self) -> Color:
-        return Color()
+    def get_primary_color(self) -> str:
+        return "white"  # Default color as string
 
-    def get_secondary_color(self):
-        return Color()
+    def get_secondary_color(self) -> str:
+        return "navy"  # Default color as string
 
     def get_plugins_data(self):
         plugins_data = gql(
@@ -307,3 +307,18 @@ class GraphQL(DB):
             """
         )
         return self.client.execute(plugins_data)["pluginConfigs"]
+
+    def health_check(self) -> None:
+        """Perform a health check on the GraphQL database.
+
+        Raises an exception if the database is not accessible.
+        """
+        # Simple query to check connectivity
+        health_query = gql(
+            """
+            query {
+              __typename
+            }
+            """
+        )
+        self.client.execute(health_query)

{platzky-0.3.6 → platzky-0.4.3}/platzky/db/json_db.py

@@ -116,3 +116,11 @@ class Json(DB):
 
     def get_plugins_data(self):
         return self.data.get("plugins", [])
+
+    def health_check(self) -> None:
+        """Perform a health check on the JSON database.
+
+        Raises an exception if the database is not accessible.
+        """
+        # Try to access site_content to ensure basic structure is valid
+        self._get_site_content()

platzky-0.4.3/platzky/db/mongodb_db.py

@@ -0,0 +1,143 @@
+import datetime
+from typing import Any
+
+from pydantic import Field
+from pymongo import MongoClient
+from pymongo.collection import Collection
+from pymongo.database import Database
+
+from platzky.db.db import DB, DBConfig
+from platzky.models import MenuItem, Page, Post
+
+
+def db_config_type():
+    return MongoDbConfig
+
+
+class MongoDbConfig(DBConfig):
+    connection_string: str = Field(alias="CONNECTION_STRING")
+    database_name: str = Field(alias="DATABASE_NAME")
+
+
+def get_db(config):
+    mongodb_config = MongoDbConfig.model_validate(config)
+    return MongoDB(mongodb_config.connection_string, mongodb_config.database_name)
+
+
+def db_from_config(config: MongoDbConfig):
+    return MongoDB(config.connection_string, config.database_name)
+
+
+class MongoDB(DB):
+    def __init__(self, connection_string: str, database_name: str):
+        super().__init__()
+        self.connection_string = connection_string
+        self.database_name = database_name
+        self.client: MongoClient[Any] = MongoClient(connection_string)
+        self.db: Database[Any] = self.client[database_name]
+        self.module_name = "mongodb_db"
+        self.db_name = "MongoDB"
+
+        # Collection references
+        self.site_content: Collection[Any] = self.db.site_content
+        self.posts: Collection[Any] = self.db.posts
+        self.pages: Collection[Any] = self.db.pages
+        self.menu_items: Collection[Any] = self.db.menu_items
+        self.plugins: Collection[Any] = self.db.plugins
+
+    def get_app_description(self, lang: str) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content and "app_description" in site_content:
+            return site_content["app_description"].get(lang, "")
+        return ""
+
+    def get_all_posts(self, lang: str) -> list[Post]:
+        posts_cursor = self.posts.find({"language": lang})
+        return [Post.model_validate(post) for post in posts_cursor]
+
+    def get_menu_items_in_lang(self, lang: str) -> list[MenuItem]:
+        menu_items_doc = self.menu_items.find_one({"_id": lang})
+        if menu_items_doc and "items" in menu_items_doc:
+            return [MenuItem.model_validate(item) for item in menu_items_doc["items"]]
+        return []
+
+    def get_post(self, slug: str) -> Post:
+        post_doc = self.posts.find_one({"slug": slug})
+        if post_doc is None:
+            raise ValueError(f"Post with slug {slug} not found")
+        return Post.model_validate(post_doc)
+
+    def get_page(self, slug: str) -> Page:
+        page_doc = self.pages.find_one({"slug": slug})
+        if page_doc is None:
+            raise ValueError(f"Page with slug {slug} not found")
+        return Page.model_validate(page_doc)
+
+    def get_posts_by_tag(self, tag: str, lang: str) -> Any:
+        posts_cursor = self.posts.find({"tags": tag, "language": lang})
+        return posts_cursor
+
+    def add_comment(self, author_name: str, comment: str, post_slug: str) -> None:
+        now_utc = datetime.datetime.now(datetime.timezone.utc).isoformat(timespec="seconds")
+        comment_doc = {
+            "author": str(author_name),
+            "comment": str(comment),
+            "date": now_utc,
+        }
+
+        result = self.posts.update_one({"slug": post_slug}, {"$push": {"comments": comment_doc}})
+        if result.matched_count == 0:
+            raise ValueError(f"Post with slug {post_slug} not found")
+
+    def get_logo_url(self) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content:
+            return site_content.get("logo_url", "")
+        return ""
+
+    def get_favicon_url(self) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content:
+            return site_content.get("favicon_url", "")
+        return ""
+
+    def get_primary_color(self) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content:
+            return site_content.get("primary_color", "white")
+        return "white"
+
+    def get_secondary_color(self) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content:
+            return site_content.get("secondary_color", "navy")
+        return "navy"
+
+    def get_plugins_data(self) -> list[Any]:
+        plugins_doc = self.plugins.find_one({"_id": "config"})
+        if plugins_doc and "data" in plugins_doc:
+            return plugins_doc["data"]
+        return []
+
+    def get_font(self) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content:
+            return site_content.get("font", "")
+        return ""
+
+    def health_check(self) -> None:
+        """Perform a health check on the MongoDB database.
+
+        Raises an exception if the database is not accessible.
+        """
+        # Simple ping to check if database is accessible
+        self.client.admin.command("ping")
+
+    def _close_connection(self) -> None:
+        """Close the MongoDB connection"""
+        if self.client:
+            self.client.close()
+
+    def __del__(self):
+        """Ensure connection is closed when object is destroyed"""
+        self._close_connection()

platzky-0.4.3/platzky/engine.py

@@ -0,0 +1,140 @@
+import os
+from concurrent.futures import ThreadPoolExecutor, TimeoutError
+from typing import Any, Callable, Dict, List, Tuple
+
+from flask import Blueprint, Flask, jsonify, make_response, request, session
+from flask_babel import Babel
+
+from platzky.config import Config
+from platzky.models import CmsModule
+
+
+class Engine(Flask):
+    def __init__(self, config: Config, db, import_name):
+        super().__init__(import_name)
+        self.config.from_mapping(config.model_dump(by_alias=True))
+        self.db = db
+        self.notifiers = []
+        self.login_methods = []
+        self.dynamic_body = ""
+        self.dynamic_head = ""
+        self.health_checks: List[Tuple[str, Callable[[], None]]] = []
+        directory = os.path.dirname(os.path.realpath(__file__))
+        locale_dir = os.path.join(directory, "locale")
+        config.translation_directories.append(locale_dir)
+        babel_translation_directories = ";".join(config.translation_directories)
+        self.babel = Babel(
+            self,
+            locale_selector=self.get_locale,
+            default_translation_directories=babel_translation_directories,
+        )
+        self._register_default_health_endpoints()
+
+        self.cms_modules: List[CmsModule] = []
+        # TODO add plugins as CMS Module - all plugins should be visible from
+        # admin page at least as configuration
+
+    def notify(self, message: str):
+        for notifier in self.notifiers:
+            notifier(message)
+
+    def add_notifier(self, notifier):
+        self.notifiers.append(notifier)
+
+    def add_cms_module(self, module: CmsModule):
+        """Add a CMS module to the modules list."""
+        self.cms_modules.append(module)
+
+    # TODO login_method should be interface
+    def add_login_method(self, login_method):
+        self.login_methods.append(login_method)
+
+    def add_dynamic_body(self, body: str):
+        self.dynamic_body += body
+
+    def add_dynamic_head(self, body: str):
+        self.dynamic_head += body
+
+    def get_locale(self) -> str:
+        domain = request.headers.get("Host", "localhost")
+        domain_to_lang = self.config.get("DOMAIN_TO_LANG")
+
+        languages = self.config.get("LANGUAGES", {}).keys()
+        backup_lang = session.get(
+            "language",
+            request.accept_languages.best_match(languages, "en"),
+        )
+
+        if domain_to_lang:
+            lang = domain_to_lang.get(domain, backup_lang)
+        else:
+            lang = backup_lang
+
+        session["language"] = lang
+        return lang
+
+    def add_health_check(self, name: str, check_function: Callable[[], None]) -> None:
+        """Register a health check function"""
+        if not callable(check_function):
+            raise TypeError(f"check_function must be callable, got {type(check_function)}")
+        self.health_checks.append((name, check_function))
+
+    def _register_default_health_endpoints(self):
+        """Register default health endpoints"""
+
+        health_bp = Blueprint("health", __name__)
+        HEALTH_CHECK_TIMEOUT = 10  # seconds
+
+        @health_bp.route("/health/liveness")
+        def liveness():
+            """Simple liveness check - is the app running?"""
+            return jsonify({"status": "alive"}), 200
+
+        @health_bp.route("/health/readiness")
+        def readiness():
+            """Readiness check - can the app serve traffic?"""
+            health_status: Dict[str, Any] = {"status": "ready", "checks": {}}
+            status_code = 200
+
+            executor = ThreadPoolExecutor(max_workers=1)
+            try:
+                # Database health check with timeout
+                future = executor.submit(self.db.health_check)
+                try:
+                    future.result(timeout=HEALTH_CHECK_TIMEOUT)
+                    health_status["checks"]["database"] = "ok"
+                except TimeoutError:
+                    health_status["checks"]["database"] = "failed: timeout"
+                    health_status["status"] = "not_ready"
+                    status_code = 503
+                except Exception as e:
+                    health_status["checks"]["database"] = f"failed: {e!s}"
+                    health_status["status"] = "not_ready"
+                    status_code = 503
+
+                # Run application-registered health checks
+                for check_name, check_func in self.health_checks:
+                    future = executor.submit(check_func)
+                    try:
+                        future.result(timeout=HEALTH_CHECK_TIMEOUT)
+                        health_status["checks"][check_name] = "ok"
+                    except TimeoutError:
+                        health_status["checks"][check_name] = "failed: timeout"
+                        health_status["status"] = "not_ready"
+                        status_code = 503
+                    except Exception as e:
+                        health_status["checks"][check_name] = f"failed: {e!s}"
+                        health_status["status"] = "not_ready"
+                        status_code = 503
+            finally:
+                # Shutdown without waiting if any futures are still running
+                executor.shutdown(wait=False)
+
+            return make_response(jsonify(health_status), status_code)
+
+        # Simple /health alias for liveness
+        @health_bp.route("/health")
+        def health():
+            return liveness()
+
+        self.register_blueprint(health_bp)

{platzky-0.3.6 → platzky-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "platzky"
-version = "0.3.6"
+version = "0.4.3"
 description = "Not only blog engine"
 authors = []
 license = "MIT"
@@ -20,6 +20,7 @@ humanize = "^4.9.0"
 pydantic = "^2.7.1"
 deprecation = "^2.1.0"
 pygithub = "^2.6.1"
+pymongo = "^4.7.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.2.1"
@@ -30,7 +31,7 @@ black = "^24.8.0"
 ruff = "^0.4.4"
 pyright = "^1.1.364"
 beautifulsoup4 = "^4.12.3"
-
+python-semantic-release = "^9.8.0"
 
 [build-system]
 requires = ["poetry-core"]
@@ -40,18 +41,17 @@ build-backend = "poetry.core.masonry.api"
 omit = [
     "tests/*",
     "*/__init__.py"
-    ]
+]
 
 [tool.coverage.report]
 exclude_lines = [
     "@abstractmethod",
     "@abc.abstractmethod"
-    ]
+]
 
 [tool.pyright]
 pythonVersion = "3.10"
 pythonPlatform = "All"
-
 typeCheckingMode = "strict"
 reportMissingImports = true
 reportMissingTypeStubs = false
@@ -87,3 +87,29 @@ lint.ignore = []
 markers = [
     "skip_coverage: skip coverage for this test"
 ]
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:tool.poetry.version"]
+build_command = "poetry build"
+dist_path = "dist/"
+upload_to_release = true
+remove_dist = false
+commit_author = "semantic-release <semantic-release>"
+commit_message = "chore(release): {version}"
+tag_format = "{version}"
+commit_parser = "conventional"
+changelog_file = "CHANGELOG.md"
+
+[tool.semantic_release.branches.main]
+match = "main"
+prerelease = false
+
+[tool.semantic_release.publish]
+dist_glob_patterns = ["dist/*"]
+upload_to_vcs_release = true
+
+[tool.semantic_release.remote]
+type = "github"
+
+[tool.semantic_release.remote.token]
+env = "GH_TOKEN"

platzky-0.3.6/platzky/engine.py

@@ -1,71 +0,0 @@
-import os
-from typing import List
-
-from flask import Flask, request, session
-from flask_babel import Babel
-
-from platzky.config import Config
-from platzky.models import CmsModule
-
-
-class Engine(Flask):
-    def __init__(self, config: Config, db, import_name):
-        super().__init__(import_name)
-        self.config.from_mapping(config.model_dump(by_alias=True))
-        self.db = db
-        self.notifiers = []
-        self.login_methods = []
-        self.dynamic_body = ""
-        self.dynamic_head = ""
-        directory = os.path.dirname(os.path.realpath(__file__))
-        locale_dir = os.path.join(directory, "locale")
-        config.translation_directories.append(locale_dir)
-        babel_translation_directories = ";".join(config.translation_directories)
-        self.babel = Babel(
-            self,
-            locale_selector=self.get_locale,
-            default_translation_directories=babel_translation_directories,
-        )
-
-        self.cms_modules: List[CmsModule] = []
-        # TODO add plugins as CMS Module - all plugins should be visible from
-        # admin page at least as configuration
-
-    def notify(self, message: str):
-        for notifier in self.notifiers:
-            notifier(message)
-
-    def add_notifier(self, notifier):
-        self.notifiers.append(notifier)
-
-    def add_cms_module(self, module: CmsModule):
-        """Add a CMS module to the modules list."""
-        self.cms_modules.append(module)
-
-    # TODO login_method should be interface
-    def add_login_method(self, login_method):
-        self.login_methods.append(login_method)
-
-    def add_dynamic_body(self, body: str):
-        self.dynamic_body += body
-
-    def add_dynamic_head(self, body: str):
-        self.dynamic_head += body
-
-    def get_locale(self) -> str:
-        domain = request.headers.get("Host", "localhost")
-        domain_to_lang = self.config.get("DOMAIN_TO_LANG")
-
-        languages = self.config.get("LANGUAGES", {}).keys()
-        backup_lang = session.get(
-            "language",
-            request.accept_languages.best_match(languages, "en"),
-        )
-
-        if domain_to_lang:
-            lang = domain_to_lang.get(domain, backup_lang)
-        else:
-            lang = backup_lang
-
-        session["language"] = lang
-        return lang