platzky 0.3.5__tar.gz → 0.4.1__tar.gz

{platzky-0.3.5 → platzky-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: platzky
-Version: 0.3.5
+Version: 0.4.1
 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.5 → platzky-0.4.1}/platzky/admin/admin.py

@@ -3,7 +3,14 @@ from os.path import dirname
 from flask import Blueprint, render_template, session
 
 
-def create_admin_blueprint(login_methods, db, locale_func):
+def create_admin_blueprint(login_methods, cms_modules):
+    """Create admin blueprint with dynamic module routes.
+
+    Args:
+        login_methods: Available login methods
+        cms_modules: List of CMS modules to register routes for
+    """
+    # …rest of the function…
     admin = Blueprint(
         "admin",
         __name__,
@@ -11,23 +18,20 @@ def create_admin_blueprint(login_methods, db, locale_func):
         template_folder=f"{dirname(__file__)}/templates",
     )
 
-    @admin.route("/", methods=["GET"])
-    def admin_panel_home():
-        user = session.get("user", None)
+    for module in cms_modules:
 
-        if not user:
-            return render_template("login.html", login_methods=login_methods)
+        @admin.route(f"/module/{module.slug}", methods=["GET"])
+        def module_route(module=module):
 
-        cms_modules = {"plugins": [plugin.get("name") for plugin in db.get_plugins_data()]}
-        return render_template("admin.html", user=user, cms_modules=cms_modules)
+            return render_template(module.template, module=module)
 
-    @admin.route("/module/<module_name>", methods=["GET"])
-    def module_settings(module_name):
+    @admin.route("/", methods=["GET"])
+    def admin_panel_home():
         user = session.get("user", None)
 
         if not user:
             return render_template("login.html", login_methods=login_methods)
 
-        return render_template("module.html", user=user, module_name=module_name)
+        return render_template("admin.html", user=user, cms_modules=cms_modules)
 
     return admin

{platzky-0.3.5 → platzky-0.4.1}/platzky/admin/templates/admin.html

@@ -18,12 +18,13 @@
 {% block left_panel %}
 <div id="admin-panel">
   <p>User: {{ user.username }}</p>
-  {% for cms_module_name, cms_entries in cms_modules.items() %}
+  {% for cms_module in cms_modules %}
   <div class="cms-module mb-2">
-    <p>{{ cms_module_name }}</p>
-    {% for cms_entry in cms_entries %}
-    <a href="{{ url_for('admin.module', name=cms_entry) }}" class="cms-entry btn btn-primary btn-block mb-2">{{ cms_entry }}</a>
-    {% endfor %}
+    <ul>
+        <li>
+            <a href="/{{ cms_module.slug }}"> {{ cms_module.name }} </a>
+        </li>
+    </ul>
   </div>
   {% endfor %}
 </div>

{platzky-0.3.5 → platzky-0.4.1}/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

{platzky-0.3.5 → platzky-0.4.1}/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(

platzky-0.4.1/platzky/db/mongodb_db.py

@@ -0,0 +1,135 @@
+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 _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.3.5 → platzky-0.4.1}/platzky/engine.py

@@ -1,9 +1,11 @@
 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):
@@ -25,6 +27,10 @@ class Engine(Flask):
             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)
@@ -32,6 +38,10 @@ class Engine(Flask):
     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)

{platzky-0.3.5 → platzky-0.4.1}/platzky/models.py

@@ -4,6 +4,22 @@ import humanize
 from pydantic import BaseModel
 
 
+class CmsModule(BaseModel):
+    """Represents a CMS module with basic metadata."""
+
+    name: str
+    description: str
+    template: str
+    slug: str
+
+
+# CmsModuleGroup is also a CmsModule, but it contains other CmsModules
+class CmsModuleGroup(CmsModule):
+    """Represents a group of CMS modules, inheriting module properties."""
+
+    modules: list[CmsModule] = []
+
+
 class Image(BaseModel):
     url: str = ""
     alternateText: str = ""

{platzky-0.3.5 → platzky-0.4.1}/platzky/platzky.py

@@ -86,7 +86,7 @@ def create_app_from_config(config: Config) -> Engine:
     engine = create_engine(config, db)
 
     admin_blueprint = admin.create_admin_blueprint(
-        login_methods=engine.login_methods, db=engine.db, locale_func=engine.get_locale
+        login_methods=engine.login_methods, cms_modules=engine.cms_modules
     )
 
     if config.feature_flags and config.feature_flags.get("FAKE_LOGIN", False):

{platzky-0.3.5 → platzky-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "platzky"
-version = "0.3.5"
+version = "0.4.1"
 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,6 +31,7 @@ black = "^24.8.0"
 ruff = "^0.4.4"
 pyright = "^1.1.364"
 beautifulsoup4 = "^4.12.3"
+python-semantic-release = "^9.0.0"
 
 
 [build-system]
@@ -87,3 +89,23 @@ 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