platzky 0.2.5__tar.gz → 0.2.6__tar.gz

{platzky-0.2.5 → platzky-0.2.6}/PKG-INFO

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

{platzky-0.2.5 → platzky-0.2.6}/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-0.2.5 → platzky-0.2.6}/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-0.2.5 → platzky-0.2.6}/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):
@@ -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,7 +69,13 @@ 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_favicon_url(self) -> str:
         pass
 
     @abstractmethod
@@ -83,7 +87,7 @@ class DB(ABC):
         pass
 
     @abstractmethod
-    def get_plugins_data(self) -> list:
+    def get_plugins_data(self) -> list[Any]:
         pass
 
     @abstractmethod

{platzky-0.2.5 → platzky-0.2.6}/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-0.2.5 → platzky-0.2.6}/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()

{platzky-0.2.5 → platzky-0.2.6}/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():
@@ -51,9 +51,7 @@ 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
@@ -64,9 +62,7 @@ class Json(DB):
         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):
         content = self.data.get("site_content")
@@ -77,6 +73,9 @@ class Json(DB):
     def get_logo_url(self):
         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", "")
 

{platzky-0.2.5 → platzky-0.2.6}/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-0.2.5 → platzky-0.2.6}/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-0.2.5 → platzky-0.2.6}/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-0.2.5 → platzky-0.2.6}/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-0.2.5 → platzky-0.2.6}/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-0.2.5 → platzky-0.2.6}/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-0.2.5 → platzky-0.2.6}/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.6/pyproject.toml

@@ -0,0 +1,87 @@
+[tool.poetry]
+name = "platzky"
+version = "0.2.6"
+description = "Not only blog engine"
+authors = []
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+Flask = "3.0.3"
+PyYAML = "^6.0"
+Flask-Babel = "^4.0.0"
+Flask-WTF = "^1.2.1"
+gql = "^3.4.0"
+aiohttp = "^3.9.5"
+Flask-Minify = "^0.42"
+google-cloud-storage = "^2.5.0"
+humanize = "^4.9.0"
+pydantic = "^2.7.1"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.2.1"
+coverage = "^7.5.1"
+pytest-cov = "^5.0.0"
+freezegun = "^1.2.2"
+black = "^24.8.0"
+ruff = "^0.4.4"
+pyright = "^1.1.364"
+beautifulsoup4 = "^4.12.3"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.coverage.run]
+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
+reportMissingParameterType = false
+reportUnknownArgumentType = false
+reportUnknownMemberType = false
+reportUnknownVariableType = false
+reportUnknownParameterType = false
+reportUnusedFunction = false
+reportUnnecessaryTypeIgnoreComment = true
+reportUntypedClassDecorator = false
+reportUnusedClass = false
+reportUntypedBaseClass = false
+
+[tool.black]
+line-length = 100
+target-version = ["py310"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+show-fixes = true
+select = [
+    "I", # isort
+    "F", # Pyflakes
+    "E", # pycodestyle Error
+    "W", # pycodestyle Warning
+    "RUF", # Ruff-specific rules
+]
+ignore = []
+
+[tool.pytest.ini_options]
+markers = [
+    "skip_coverage: skip coverage for this test"
+]

platzky-0.2.5/pyproject.toml

@@ -1,47 +0,0 @@
-[tool.poetry]
-name = "platzky"
-version = "0.2.5"
-description = "Not only blog engine"
-authors = []
-license = "MIT"
-readme = "README.md"
-
-[tool.poetry.dependencies]
-python = "^3.10"
-Flask = "3.0.3"
-PyYAML = "^6.0"
-Flask-Babel = "^4.0.0"
-Flask-WTF = "^1.2.1"
-gql = "^3.4.0"
-aiohttp = "^3.9.5"
-Flask-Minify = "^0.42"
-google-cloud-storage = "^2.5.0"
-humanize = "^4.9.0"
-pydantic = "^2.7.1"
-
-[tool.poetry.group.dev.dependencies]
-pytest = "^8.2.1"
-coverage = "^7.5.1"
-pytest-cov = "^5.0.0"
-freezegun = "^1.2.2"
-black = "^24.4.2"
-ruff = "^0.4.4"
-pyright = "^1.1.364"
-beautifulsoup4 = "^4.12.3"
-
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.coverage.run]
-omit = [
-    "tests/*",
-    "*/__init__.py"
-    ]
-
-[tool.coverage.report]
-exclude_lines = [
-    "@abstractmethod",
-    "@abc.abstractmethod"
-    ]

{platzky-0.2.5 → platzky-0.2.6}/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