platzky 0.2.4__py3-none-any.whl → 0.2.6__py3-none-any.whl

platzky/__init__.py

@@ -1,3 +1,3 @@
+from .platzky import Engine as Engine
 from .platzky import create_app_from_config as create_app_from_config
 from .platzky import create_engine as create_engine
-from .platzky import Engine as Engine

platzky/blog/blog.py

@@ -35,9 +35,7 @@ def create_blog_blueprint(db, blog_prefix: str, locale_func):
     @blog.route("/feed", methods=["GET"])
     def get_feed():
         lang = locale_func()
-        response = make_response(
-            render_template("feed.xml", posts=db.get_all_posts(lang))
-        )
+        response = make_response(render_template("feed.xml", posts=db.get_all_posts(lang)))
         response.headers["Content-Type"] = "application/xml"
         return response
 

platzky/config.py

@@ -1,7 +1,8 @@
 import sys
 import typing as t
+
 import yaml
-from pydantic import ConfigDict, BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from .db.db import DBConfig
 from .db.db_loader import get_db_module

platzky/db/db.py

@@ -1,10 +1,10 @@
+from abc import ABC, abstractmethod
 from functools import partial
 from typing import Any, Callable
 
 from pydantic import BaseModel, Field
 
-from abc import abstractmethod, ABC
-from ..models import MenuItem, Post, Page, Color
+from ..models import Color, MenuItem, Page, Post
 
 
 class DB(ABC):
@@ -14,7 +14,7 @@ class DB(ABC):
 
     def __init_subclass__(cls, *args, **kw):
         """Check that all methods defined in the subclass exist in the superclasses.
-        This is to prevent subclasses from adding new methods to the DB object.
+        This is to prevent subclasses from splitting up DB interface.
         """
         super().__init_subclass__(*args, **kw)
         for name in cls.__dict__:
@@ -28,7 +28,7 @@ class DB(ABC):
                     f"Method {name} defined in {cls.__name__} does not exist in superclasses"
                 )
 
-    def extend(self, function_name: str, function: Callable) -> None:
+    def extend(self, function_name: str, function: Callable[..., Any]) -> None:
         """
         Add a function to the DB object. The function must take the DB object as first parameter.
 
@@ -37,9 +37,7 @@ class DB(ABC):
         function (Callable): The function to add to the DB object.
         """
         if not callable(function):
-            raise ValueError(
-                f"The provided func for '{function_name}' is not callable."
-            )
+            raise ValueError(f"The provided func for '{function_name}' is not callable.")
         try:
             bound_function = partial(function, self)
             setattr(self, function_name, bound_function)
@@ -71,27 +69,29 @@ class DB(ABC):
         pass
 
     @abstractmethod
-    def get_logo_url(self) -> str:
+    def get_logo_url(
+        self,
+    ) -> str:  # TODO provide alternative text along with the URL of logo
         pass
 
     @abstractmethod
-    def get_primary_color(self) -> Color:
+    def get_favicon_url(self) -> str:
         pass
 
     @abstractmethod
-    def get_secondary_color(self) -> Color:
+    def get_primary_color(self) -> Color:
         pass
 
     @abstractmethod
-    def get_plugins_data(self) -> list:
+    def get_secondary_color(self) -> Color:
         pass
 
     @abstractmethod
-    def get_font(self) -> str:
+    def get_plugins_data(self) -> list[Any]:
         pass
 
     @abstractmethod
-    def get_site_content(self) -> str:
+    def get_font(self) -> str:
         pass
 
 

platzky/db/google_json_db.py

@@ -22,9 +22,7 @@ def db_from_config(config: GoogleJsonDbConfig):
 
 def get_db(config):
     google_json_db_config = GoogleJsonDbConfig.model_validate(config)
-    return GoogleJsonDb(
-        google_json_db_config.bucket_name, google_json_db_config.source_blob_name
-    )
+    return GoogleJsonDb(google_json_db_config.bucket_name, google_json_db_config.source_blob_name)
 
 
 def get_blob(bucket_name, source_blob_name):

platzky/db/graph_ql_db.py

@@ -5,8 +5,8 @@ from gql import Client, gql
 from gql.transport.aiohttp import AIOHTTPTransport
 from pydantic import Field
 
-from .db import DB, DBConfig
 from ..models import Color, Post
+from .db import DB, DBConfig
 
 
 def db_config_type():
@@ -58,9 +58,7 @@ class GraphQL(DB):
         self.module_name = "graph_ql_db"
         self.db_name = "GraphQLDb"
         full_token = "bearer " + token
-        transport = AIOHTTPTransport(
-            url=endpoint, headers={"Authorization": full_token}
-        )
+        transport = AIOHTTPTransport(url=endpoint, headers={"Authorization": full_token})
         self.client = Client(transport=transport)
         super().__init__()
 
@@ -97,9 +95,7 @@ class GraphQL(DB):
             }
             """
         )
-        raw_ql_posts = self.client.execute(all_posts, variable_values={"lang": lang})[
-            "posts"
-        ]
+        raw_ql_posts = self.client.execute(all_posts, variable_values={"lang": lang})["posts"]
 
         return [Post.model_validate(_standarize_post(post)) for post in raw_ql_posts]
 
@@ -127,7 +123,7 @@ class GraphQL(DB):
                 slug
                 author {
                     name
-                }                
+                }
                 contentInRichText {
                   markdown
                   html
@@ -191,9 +187,7 @@ class GraphQL(DB):
             }
             """
         )
-        return self.client.execute(post, variable_values={"tag": tag, "lang": lang})[
-            "posts"
-        ]
+        return self.client.execute(post, variable_values={"tag": tag, "lang": lang})["posts"]
 
     def add_comment(self, author_name, comment, post_slug):
         add_comment = gql(
@@ -224,7 +218,39 @@ class GraphQL(DB):
         return str("")
 
     def get_logo_url(self):
-        return ""
+        logo = gql(
+            """
+            query myquery {
+              logos(stage: PUBLISHED) {
+              logo {
+                  alternateText
+                  image {
+                    url
+                  }
+                }
+              }
+            }
+            """
+        )
+        try:
+            return self.client.execute(logo)["logos"][0]["logo"]["image"]["url"]
+        except IndexError:
+            return ""
+
+    def get_favicon_url(self):
+        favicon = gql(
+            """
+            query myquery {
+              favicons(stage: PUBLISHED) {
+              favicon {
+                url
+                }
+              }
+            }
+            """
+        )
+
+        return self.client.execute(favicon)["favicons"][0]["favicon"]["url"]
 
     def get_primary_color(self) -> Color:
         return Color()
@@ -232,8 +258,15 @@ class GraphQL(DB):
     def get_secondary_color(self):
         return Color()
 
-    def get_site_content(self):
-        return ""
-
     def get_plugins_data(self):
-        return []
+        plugins_data = gql(
+            """
+            query MyQuery {
+              pluginConfigs(stage: PUBLISHED) {
+                name
+                config
+              }
+            }
+            """
+        )
+        return self.client.execute(plugins_data)["pluginConfigs"]

platzky/db/json_db.py

@@ -3,8 +3,8 @@ from typing import Any, Dict
 
 from pydantic import Field
 
-from .db import DB, DBConfig
 from ..models import MenuItem, Post
+from .db import DB, DBConfig
 
 
 def db_config_type():
@@ -34,13 +34,13 @@ class Json(DB):
     def get_all_posts(self, lang):
         return [
             Post.model_validate(post)
-            for post in self.get_site_content().get("posts", ())
+            for post in self._get_site_content().get("posts", ())
             if post["language"] == lang
         ]
 
     def get_post(self, slug: str) -> Post:
         """Returns a post matching the given slug."""
-        all_posts = self.get_site_content().get("posts")
+        all_posts = self._get_site_content().get("posts")
         if all_posts is None:
             raise ValueError("Posts data is missing")
         wanted_post = next((post for post in all_posts if post["slug"] == slug), None)
@@ -51,40 +51,39 @@ class Json(DB):
     # TODO: add test for non-existing page
     def get_page(self, slug):
         list_of_pages = (
-            page
-            for page in self.get_site_content().get("pages")
-            if page["slug"] == slug
+            page for page in self._get_site_content().get("pages") if page["slug"] == slug
         )
         page = Post.model_validate(next(list_of_pages))
         return page
 
     def get_menu_items(self) -> list[MenuItem]:
-        menu_items_raw = self.get_site_content().get("menu_items", [])
+        menu_items_raw = self._get_site_content().get("menu_items", [])
         menu_items_list = [MenuItem.model_validate(x) for x in menu_items_raw]
         return menu_items_list
 
     def get_posts_by_tag(self, tag, lang):
-        return (
-            post for post in self.get_site_content()["posts"] if tag in post["tags"]
-        )
+        return (post for post in self._get_site_content()["posts"] if tag in post["tags"])
 
-    def get_site_content(self):
+    def _get_site_content(self):
         content = self.data.get("site_content")
         if content is None:
             raise Exception("Content should not be None")
         return content
 
     def get_logo_url(self):
-        return self.get_site_content().get("logo_url", "")
+        return self._get_site_content().get("logo_url", "")
+
+    def get_favicon_url(self):
+        return self._get_site_content().get("favicon_url", "")
 
     def get_font(self) -> str:
-        return self.get_site_content().get("font", "")
+        return self._get_site_content().get("font", "")
 
     def get_primary_color(self):
-        return self.get_site_content().get("primary_color", "white")
+        return self._get_site_content().get("primary_color", "white")
 
     def get_secondary_color(self):
-        return self.get_site_content().get("secondary_color", "navy")
+        return self._get_site_content().get("secondary_color", "navy")
 
     def add_comment(self, author_name, comment, post_slug):
         comment = {
@@ -95,10 +94,10 @@ class Json(DB):
 
         post_index = next(
             i
-            for i in range(len(self.get_site_content()["posts"]))
-            if self.get_site_content()["posts"][i]["slug"] == post_slug
+            for i in range(len(self._get_site_content()["posts"]))
+            if self._get_site_content()["posts"][i]["slug"] == post_slug
         )
-        self.get_site_content()["posts"][post_index]["comments"].append(comment)
+        self._get_site_content()["posts"][post_index]["comments"].append(comment)
 
     def get_plugins_data(self):
         return self.data.get("plugins", [])

platzky/models.py

@@ -1,6 +1,7 @@
-from pydantic import BaseModel
 import datetime
+
 import humanize
+from pydantic import BaseModel
 
 
 class Image(BaseModel):
@@ -40,7 +41,7 @@ class Post(BaseModel):
     def __lt__(self, other):
         if isinstance(other, Post):
             return self.date < other.date
-        return NotImplemented
+        raise NotImplementedError("Posts can only be compared with other posts")
 
 
 Page = Post

platzky/platzky.py

@@ -87,12 +87,6 @@ def create_engine(config: Config, db) -> Engine:
             session["language"] = lang
             return redirect(request.referrer)
 
-    @app.route("/logo", methods=["GET"])
-    def logo():
-        return redirect(
-            "https://www.problematy.pl/wp-content/uploads/2023/08/kolor_poziom.png"
-        )
-
     def url_link(x: str) -> str:
         return urllib.parse.quote(x, safe="")
 
@@ -108,6 +102,7 @@ def create_engine(config: Config, db) -> Engine:
             "url_link": url_link,
             "menu_items": app.db.get_menu_items(),
             "logo_url": app.db.get_logo_url(),
+            "favicon_url": app.db.get_favicon_url(),
             "font": app.db.get_font(),
             "primary_color": app.db.get_primary_color(),
             "secondary_color": app.db.get_secondary_color(),

platzky/plugins/redirections/entrypoint.py

@@ -27,8 +27,7 @@ def graph_ql_db_get_redirections(self):
         """
     )
     return {
-        x["source"]: x["destination"]
-        for x in self.client.execute(redirections)["redirections"]
+        x["source"]: x["destination"] for x in self.client.execute(redirections)["redirections"]
     }
 
 
@@ -37,11 +36,8 @@ class Redirection(BaseModel):
     destiny: str
 
 
-def parse_redirections(config: dict) -> list[Redirection]:
-    return [
-        Redirection(source=source, destiny=destiny)
-        for source, destiny in config.items()
-    ]
+def parse_redirections(config: dict[str, str]) -> list[Redirection]:
+    return [Redirection(source=source, destiny=destiny) for source, destiny in config.items()]
 
 
 def setup_routes(app, redirections):
@@ -62,7 +58,7 @@ def redirect_with_name(destiny, code, name):
     return named_redirect
 
 
-def process(app, config: dict) -> object:
+def process(app, config: dict[str, str]) -> object:
     redirections = parse_redirections(config)
     setup_routes(app, redirections)
     return app

platzky/plugins/sendmail/entrypoint.py

@@ -3,12 +3,8 @@ import smtplib
 from pydantic import BaseModel, Field
 
 
-def send_mail(
-    sender_email, password, smtp_server, port, receiver_email, subject, message
-):
-    full_message = (
-        f"From: {sender_email}\nTo: {receiver_email}\nSubject: {subject}\n\n{message}"
-    )
+def send_mail(sender_email, password, smtp_server, port, receiver_email, subject, message):
+    full_message = f"From: {sender_email}\nTo: {receiver_email}\nSubject: {subject}\n\n{message}"
     server = smtplib.SMTP_SSL(smtp_server, port)
     server.ehlo()
     server.login(sender_email, password)

platzky/seo/seo.py

@@ -1,6 +1,7 @@
 import typing as t
 import urllib.parse
 from os.path import dirname
+
 from flask import Blueprint, current_app, make_response, render_template, request
 
 
@@ -14,9 +15,7 @@ def create_seo_blueprint(db, config: dict[str, t.Any]):
 
     @seo.route("/robots.txt")
     def robots():
-        robots_response = render_template(
-            "robots.txt", domain=request.host, mimetype="text/plain"
-        )
+        robots_response = render_template("robots.txt", domain=request.host, mimetype="text/plain")
         response = make_response(robots_response)
         response.headers["Content-Type"] = "text/plain"
         return response
@@ -45,12 +44,8 @@ def create_seo_blueprint(db, config: dict[str, t.Any]):
         static_urls = list()
         for rule in current_app.url_map.iter_rules():
             if not str(rule).startswith("/admin") and not str(rule).startswith("/user"):
-                if (
-                    rule.methods is not None
-                    and "GET" in rule.methods
-                    and len(rule.arguments) == 0
-                ):
-                    url = {"loc": f"{host_base}{str(rule)}"}
+                if rule.methods is not None and "GET" in rule.methods and len(rule.arguments) == 0:
+                    url = {"loc": f"{host_base}{rule!s}"}
                     static_urls.append(url)
 
         # Dynamic routes with dynamic content

platzky/templates/base.html

@@ -11,7 +11,7 @@
   <link rel="stylesheet" href="https://unpkg.com/leaflet.markercluster@1.5.3/dist/MarkerCluster.Default.css" />
   <link rel="stylesheet" href="{{ font.url }}">
   {% endblock %}
-  <title>{% block title %} {{app_name}} {% endblock %}</title>
+  <title>{% block title %}{{app_name}}{% endblock %}</title>
   <meta name="description" content=" {% block description %} {% endblock %} ">
   <style>
     html,
@@ -98,13 +98,7 @@
         <i class="fas fa-sliders-h"></i>
       </button>
       {% endif %}
-      <a class="navbar-brand" href="/">
-        {% if logo_url %}
-        <img src="{{ logo_url }}" class="logo" >
-        {% else %}
-        {{ _(app_name) }}
-        {% endif %}
-      </a>
+      <a class="navbar-brand" href="/">{% if logo_url %}<img src="{{ logo_url }}" class="logo">{% else %}{{_(app_name)}}{% endif %}</a>
       <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav"
               aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
         <i class="fas fa-bars"></i>

platzky/templates/head_meta.html

@@ -2,8 +2,7 @@
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 <link rel="alternate" hreflang="{{ current_language }}" href="{{ request.base_url }}"/>
-<link rel="shortcut icon" href="{{ url_for('static', filename='favicon.png') }}" type="image/x-icon">
-
+<link rel="shortcut icon" href="{{ favicon_url }}" type="image/x-icon">
 <link rel="canonical" href="{{ request.base_url }}"/>
 
 <!-- Bootstrap CSS -->

{platzky-0.2.4.dist-info → platzky-0.2.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: platzky
-Version: 0.2.4
+Version: 0.2.6
 Summary: Not only blog engine
 License: MIT
 Requires-Python: >=3.10,<4.0

{platzky-0.2.4.dist-info → platzky-0.2.6.dist-info}/RECORD

@@ -1,35 +1,35 @@
-platzky/__init__.py,sha256=kzi_UifSAOPFmTY0uyPbKDdJHu0MtUKKdev9NVFjJfA,160
+platzky/__init__.py,sha256=cEAqMh-FU8mbfCzFQaWMhKX4lDjoxDiQ9S4hTNsSOMg,160
 platzky/blog/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-platzky/blog/blog.py,sha256=R1Otio2Ix5d02CT9mtYZ_kKMbKJArsuJdJLjCfc4Qxg,3031
+platzky/blog/blog.py,sha256=caBUewnwd6QrJDv20m4JDfDDjiVu7hM0AJnoTyCdwM4,3009
 platzky/blog/comment_form.py,sha256=4lkNJ_S_2DZmJBbz-NPDqahvy2Zz5AGNH2spFeGIop4,513
-platzky/config.py,sha256=XL4oASEZQtc6iNfiLkAJaHp9fUX3A53DEpCXznYyOrQ,2203
+platzky/config.py,sha256=WStlXnvoa9sCGPqKW6FuN1GIcp_MIV08FjPME9TD7x4,2204
 platzky/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-platzky/db/db.py,sha256=0smTAiP4MDKOF_t60-KVKs1h-oTGydrWvAgPavFjDDo,2660
+platzky/db/db.py,sha256=SayR69Nxs9aGMfYumLyLIH0LVLVmwiQt9WAICq59gng,2709
 platzky/db/db_loader.py,sha256=CuEiXxhIa4bFMm0vi7ugzm7j3WycilGRKCU6smgIImE,905
-platzky/db/google_json_db.py,sha256=65NKwbalGA1FfQz724dAK_3PS9e-MeLUb7WZkVU6nBo,1513
-platzky/db/graph_ql_db.py,sha256=jAfz9WK7tYjTFFwurR0piuW_M79vK7IbV9AbQpNLnOo,6444
-platzky/db/json_db.py,sha256=lbDZiEDWZebd9sssF8td1HKod4o7CdIvHu2fcPFgs7U,3184
+platzky/db/google_json_db.py,sha256=IgfCER7oJ4I_WD4TjhvFFL0voUj6EfeoaVWdoEcHTdA,1499
+platzky/db/graph_ql_db.py,sha256=aIqRxPV-Txr5MY2-qVALby9fHyIvWgvSz2t24M9SNRI,7343
+platzky/db/json_db.py,sha256=AtZoTcM6S2ZHo19rxkCi4h4E4INGieZ4W6H5O2iormA,3246
 platzky/db/json_file_db.py,sha256=UQ8TadELmqOzj_tgNfmzhtCkDkMAgcB9vaUy0GQXUY4,1010
-platzky/models.py,sha256=8ATKVrGRtQ1JV_z7IdYbx1cxBU7ISoXjTmNxTlxok-k,1450
-platzky/platzky.py,sha256=3KljmS4lTB1yscOSDoavZ2yFwHcdQ_K8Om8qlJBA73U,4649
+platzky/models.py,sha256=-IIlyeLzACeTUpzuzvzJYxtT57E6wRiERoRgXJYMMtY,1502
+platzky/platzky.py,sha256=-01WVpSxZz96NoilFB_2ispHLRrquCsMR9p3F7Tyf1s,4525
 platzky/plugin_loader.py,sha256=KYLDSEd_hseAgBuSbikerU_IFx-YmcYK5UwYw7kla2E,1106
 platzky/plugins/google-tag-manager/entrypoint.py,sha256=yY5UqFvSdj3tt2upwNS8JkTrKcrbwlaaE2XQ6sRiGLc,1011
-platzky/plugins/redirections/entrypoint.py,sha256=HZsZBr8f7UkdYW0AJfUuG1vdEvWcpjoWMfm3cUXVHD4,1565
-platzky/plugins/sendmail/entrypoint.py,sha256=ioVUh_YgxyA4DnHRBUbg9ze08EKX_iCbFhbK145icjE,1237
-platzky/seo/seo.py,sha256=5Rl-ZQ3DWw65x0V7mpIkmUfxXTb6i5PEbIrAX7pzV70,2710
+platzky/plugins/redirections/entrypoint.py,sha256=yoqHsRLqRALdICs5_UMSREkfEo1Lbsjj9tqEA7dsseg,1555
+platzky/plugins/sendmail/entrypoint.py,sha256=16GszfLaYhVUSuCdL4SPVKYN9-mONp-hK5ZWSiLluPo,1215
+platzky/seo/seo.py,sha256=l59Ol56YfJB4bk4IzypYVASYCjLrjJqXRXMIcc4EUZY,2606
 platzky/static/blog.css,sha256=jF-8ykgpbPp58SCUqygBhCm4o7ggULojbxpnk6Jbx3c,7895
 platzky/templates/404.html,sha256=EheoLSWylOscLH8FmcMA4c6Jw14i5HkSvE_GXzGIrUo,78
-platzky/templates/base.html,sha256=XpY5GOsuXiroLzSo0sQqIMIGSGx5AyhdHQOK9ioxVXM,4988
+platzky/templates/base.html,sha256=6ZunlASdsCv9n0PWZBznQrRBKsnmWYRPweX9Ml-EhCo,4931
 platzky/templates/blog.html,sha256=aPl-DzLX85bHv7tN8UjlABR086PUJ9IGlGbIBioFHGA,1281
 platzky/templates/body_meta.html,sha256=au61f54ZK8SdovSpoUROjyy5fi3K6n_N5P-QjW7S5-8,526
 platzky/templates/feed.xml,sha256=I9cz7vnxx-TfbLIDHFXfrC3S2Nt9B6PrWf3u4zSIi78,863
-platzky/templates/head_meta.html,sha256=AEUPScGOBOQl6OIZ6NhcY0Sh3A17T8KHwJ3hmI4AYuA,1380
+platzky/templates/head_meta.html,sha256=tpwNeaxQwlM6Gnmz1v2fboxqbm0qYPDP-fYeeTSKPKI,1349
 platzky/templates/home.html,sha256=nqoVVvaNBd1ceun6KOZB_eY20xf4Mjtu8LTl1Q_Ap6c,3900
 platzky/templates/page.html,sha256=8tS9K5dXfCKItvOlpEuURnWohnWjs6WW6zeBJFLARUM,647
 platzky/templates/post.html,sha256=GSgjIZsOQKtNx3cEbquSjZ5L4whPnG6MzRyoq9k4B8Q,1906
 platzky/templates/robots.txt,sha256=2_j2tiYtYJnzZUrANiX9pvBxyw5Dp27fR_co18BPEJ0,116
 platzky/templates/sitemap.xml,sha256=iIJZ91_B5ZuNLCHsRtsGKZlBAXojOTP8kffqKLacgvs,578
 platzky/www_handler.py,sha256=pF6Rmvem1sdVqHD7z3RLrDuG-CwAqfGCti50_NPsB2w,725
-platzky-0.2.4.dist-info/METADATA,sha256=0OfFP9xpFYKvGbAnNVJ9qsKyq5D6l2FvsnsPxEzr3GE,1591
-platzky-0.2.4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-platzky-0.2.4.dist-info/RECORD,,
+platzky-0.2.6.dist-info/METADATA,sha256=maIpLxUQ2j_GtjB1KTkY0LC4obJoildhpkrWZTNVCag,1591
+platzky-0.2.6.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+platzky-0.2.6.dist-info/RECORD,,