blurry-cli 0.13.0__tar.gz → 0.14.0__tar.gz

{blurry_cli-0.13.0 → blurry_cli-0.14.0}/PKG-INFO

@@ -1,18 +1,16 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: blurry-cli
-Version: 0.13.0
+Version: 0.14.0
 Summary: A Mistune-based static site generator for Python
-Home-page: https://github.com/blurry-dev/blurry
 License: MIT
 Keywords: static-site-generator,seo,pagespeed
 Author: John Franey
 Author-email: franey@duck.com
-Requires-Python: >=3.10,<4.0
+Requires-Python: >=3.11,<4.0
 Classifier: Environment :: Console
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -21,21 +19,20 @@ Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Text Processing :: Markup :: HTML
 Classifier: Topic :: Text Processing :: Markup :: Markdown
-Requires-Dist: Jinja2 (>=3.0.0,<4.0.0)
-Requires-Dist: PyLD (>=2.0.3,<3.0.0)
-Requires-Dist: Wand (>=0.6.6,<0.7.0)
-Requires-Dist: dpath (>=2.1.6,<3.0.0)
+Requires-Dist: Jinja2 (>=3.1.5,<4.0.0)
+Requires-Dist: PyLD (>=2.0.4,<3.0.0)
+Requires-Dist: Wand (>=0.6.13,<0.7.0)
+Requires-Dist: dpath (>=2.2.0,<3.0.0)
 Requires-Dist: ffmpeg-python (>=0.2.0,<0.3.0)
 Requires-Dist: htmlmin2 (>=0.1.13,<0.2.0)
 Requires-Dist: jinja2-simple-tags (>=0.6.1,<0.7.0)
 Requires-Dist: jinjax (>=0.48,<0.49)
-Requires-Dist: livereload (>=2.7.0,<3.0.0)
-Requires-Dist: mistune (>=3.0.2,<4.0.0)
-Requires-Dist: pydantic2-schemaorg (>=0.2.0,<0.3.0)
-Requires-Dist: rich (>=13.3.3,<14.0.0)
+Requires-Dist: livereload (>=2.7.1,<3.0.0)
+Requires-Dist: mistune (>=3.1.0,<4.0.0)
+Requires-Dist: pydantic (>=2.10.5,<3.0.0)
+Requires-Dist: rich (>=13.9.4,<14.0.0)
 Requires-Dist: selectolax (>=0.3.27,<0.4.0)
-Requires-Dist: toml (>=0.10.2,<0.11.0)
-Requires-Dist: typer (>=0.6.1,<0.7.0)
+Requires-Dist: typer (>=0.15.1,<0.16.0)
 Project-URL: Repository, https://github.com/blurry-dev/blurry
 Description-Content-Type: text/markdown
 
@@ -44,9 +41,10 @@ Description-Content-Type: text/markdown
 [![Nox build status](https://github.com/blurry-dev/blurry/actions/workflows/github-actions-nox.yml/badge.svg?branch=main)](https://github.com/blurry-dev/blurry/actions/workflows/github-actions-nox.yml)
 [![PyPI package version](https://img.shields.io/pypi/v/blurry-cli.svg)](https://pypi.org/project/blurry-cli/)
 [![PyPI Python versions](https://img.shields.io/pypi/pyversions/blurry-cli.svg)](https://pypi.org/project/blurry-cli/)
+[![PyPI downloads per month](https://img.shields.io/pypi/dm/blurry-cli.svg)](https://pypi.python.org/pypi/blurry-cli/)
 ![Package license](https://img.shields.io/github/license/blurry-dev/blurry.svg)
 
-![Blurry logo](docs/content/favicon.png)
+![Blurry logo](https://github.com/blurry-dev/blurry/raw/main/docs/content/favicon.png)
 
 ## tl;dr
 
@@ -57,6 +55,8 @@ Blurry also makes your images responsive, supports embedding Python source code
 
 Check out the docs and try it out!
 
+**Note**: Until v1.0.0, minor versions (0.x.0) may not be backwards compatible.
+
 ## Documentation
 
 View the documentation site at <https://blurry-docs.netlify.app/>.
@@ -66,6 +66,11 @@ View the documentation site at <https://blurry-docs.netlify.app/>.
 Contributions are welcome!
 Check out [the contribution docs](https://github.com/blurry-dev/blurry/blob/main/CONTRIBUTING.md) to get started.
 
+## Security contact information
+
+To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
+
 ## Standing on the shoulders of giants
 
 Blurry blends together high-quality libraries:

{blurry_cli-0.13.0 → blurry_cli-0.14.0}/README.md

@@ -3,9 +3,10 @@
 [![Nox build status](https://github.com/blurry-dev/blurry/actions/workflows/github-actions-nox.yml/badge.svg?branch=main)](https://github.com/blurry-dev/blurry/actions/workflows/github-actions-nox.yml)
 [![PyPI package version](https://img.shields.io/pypi/v/blurry-cli.svg)](https://pypi.org/project/blurry-cli/)
 [![PyPI Python versions](https://img.shields.io/pypi/pyversions/blurry-cli.svg)](https://pypi.org/project/blurry-cli/)
+[![PyPI downloads per month](https://img.shields.io/pypi/dm/blurry-cli.svg)](https://pypi.python.org/pypi/blurry-cli/)
 ![Package license](https://img.shields.io/github/license/blurry-dev/blurry.svg)
 
-![Blurry logo](docs/content/favicon.png)
+![Blurry logo](https://github.com/blurry-dev/blurry/raw/main/docs/content/favicon.png)
 
 ## tl;dr
 
@@ -16,6 +17,8 @@ Blurry also makes your images responsive, supports embedding Python source code
 
 Check out the docs and try it out!
 
+**Note**: Until v1.0.0, minor versions (0.x.0) may not be backwards compatible.
+
 ## Documentation
 
 View the documentation site at <https://blurry-docs.netlify.app/>.
@@ -25,6 +28,11 @@ View the documentation site at <https://blurry-docs.netlify.app/>.
 Contributions are welcome!
 Check out [the contribution docs](https://github.com/blurry-dev/blurry/blob/main/CONTRIBUTING.md) to get started.
 
+## Security contact information
+
+To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
+
 ## Standing on the shoulders of giants
 
 Blurry blends together high-quality libraries:

blurry_cli-0.14.0/blurry/__init__.py

@@ -0,0 +1,210 @@
+import asyncio
+import concurrent.futures
+import importlib
+import os
+import pkgutil
+import sys
+from datetime import datetime
+from pathlib import Path
+
+from livereload import Server
+from rich import print
+from rich.console import Console
+from rich.progress import BarColumn
+from rich.progress import Progress
+from rich.progress import TaskProgressColumn
+from rich.progress import TextColumn
+
+from blurry.async_typer import AsyncTyper
+from blurry.cli import print_blurry_name
+from blurry.cli import print_plugin_table
+from blurry.commands.clean import clean_build_directory
+from blurry.commands.init import initialize_new_project
+from blurry.constants import ENV_VAR_PREFIX
+from blurry.file_processors import process_non_markdown_file
+from blurry.file_processors import write_html_file
+from blurry.gather_file_data_by_directory import gather_file_data_by_directory
+from blurry.runserver_handlers import handle_changed_jinja_files
+from blurry.runserver_handlers import handle_changed_markdown_files
+from blurry.runserver_handlers import rebuild_markdown_files
+from blurry.settings import get_build_directory
+from blurry.settings import get_content_directory
+from blurry.settings import SETTINGS
+from blurry.settings import update_settings
+from blurry.sitemap import write_sitemap_file
+from blurry.templates import get_jinja_env
+
+
+warning_console = Console(stderr=True, style="bold yellow")
+
+
+app = AsyncTyper()
+
+
+@app.command(name="clean")
+def clean_command():
+    clean_build_directory()
+
+
+@app.command(name="init")
+def init_command(name: str | None = None, domain: str | None = None):
+    initialize_new_project(name, domain)
+
+
+@app.async_command()
+async def build(release=True, clean: bool = False):
+    """Generates HTML content from Markdown files."""
+    start = datetime.now()
+
+    if release:
+        print_blurry_name()
+        print_plugin_table()
+
+    update_settings()
+    build_directory = get_build_directory()
+
+    if clean:
+        clean_build_directory()
+
+    build_directory.mkdir(parents=True, exist_ok=True)
+
+    content_directory = get_content_directory()
+    build_directory.mkdir(parents=True, exist_ok=True)
+    jinja_env = get_jinja_env()
+
+    os.environ.setdefault(f"{ENV_VAR_PREFIX}BUILD_MODE", "prod" if release else "dev")
+
+    file_data_by_directory = gather_file_data_by_directory()
+
+    markdown_task_count = 0
+    non_markdown_task_count = 1  # sitemap
+
+    with Progress(
+        TextColumn("[progress.description]{task.description}"),
+        BarColumn(),
+        TaskProgressColumn(),
+        transient=True,
+    ) as progress:
+        with concurrent.futures.ThreadPoolExecutor() as executor:
+            markdown_task = progress.add_task("[blue]Markdown")
+            other_task = progress.add_task("[blue]Other")
+
+            sitemap_future = executor.submit(write_sitemap_file, file_data_by_directory)
+            sitemap_future.add_done_callback(lambda _: progress.advance(other_task))
+
+            for filepath in content_directory.rglob("*"):
+                if filepath.is_dir():
+                    continue
+                if filepath.suffix == ".md":
+
+                    def on_markdown_file_processed(future: concurrent.futures.Future):
+                        progress.advance(markdown_task)
+                        if exception := future.exception():
+                            print(f"{filepath}: could not process file - {exception}")
+
+                    markdown_future = executor.submit(
+                        write_html_file,
+                        filepath.relative_to(content_directory),
+                        file_data_by_directory,
+                        release,
+                        jinja_env,
+                    )
+                    markdown_task_count += 1
+                    progress.update(markdown_task, total=markdown_task_count)
+                    markdown_future.add_done_callback(on_markdown_file_processed)
+                    continue
+                other_future = executor.submit(
+                    process_non_markdown_file,
+                    filepath,
+                    file_data_by_directory,
+                    jinja_env,
+                )
+                non_markdown_task_count += 1
+                progress.update(other_task, total=non_markdown_task_count)
+
+                def on_non_markdown_file_processed(future: concurrent.futures.Future):
+                    progress.advance(other_task)
+                    if exception := future.exception():
+                        print(f"{filepath}: could not process file - {exception}")
+
+                other_future.add_done_callback(on_non_markdown_file_processed)
+
+            print(
+                f"Blurring {markdown_task_count} Markdown files and {non_markdown_task_count} other files"
+            )
+
+    end = datetime.now()
+
+    difference = end - start
+    print(f"Built site in {difference.total_seconds()} seconds")
+
+
+async def reload_local_plugins_and_build():
+    """Reloads a project's local modules and performs a dev build"""
+    cwd = str(Path.cwd())
+
+    for _, package_name, _ in pkgutil.iter_modules([cwd]):
+        try:
+            module = sys.modules[package_name]
+        except KeyError:
+            continue
+        importlib.reload(module)
+
+    await build(release=False)
+
+
+@app.command()
+def runserver():
+    """Starts HTTP server with live reloading."""
+    print_blurry_name()
+    print_plugin_table()
+
+    update_settings()
+    os.environ.setdefault(f"{ENV_VAR_PREFIX}BUILD_MODE", "dev")
+
+    SETTINGS["RUNSERVER"] = True
+
+    event_loop = asyncio.get_event_loop()
+    event_loop.create_task(build(release=False))
+
+    jinja_env = get_jinja_env()
+
+    livereload_server = Server()
+    livereload_server.watch(
+        f"{SETTINGS['CONTENT_DIRECTORY_NAME']}/**/*.jinja",
+        lambda filepaths: handle_changed_jinja_files(filepaths, jinja_env),
+    )
+    livereload_server.watch(
+        f"{SETTINGS['CONTENT_DIRECTORY_NAME']}/**/*.md",
+        lambda filepaths: handle_changed_markdown_files(filepaths, jinja_env),
+    )
+    livereload_server.watch(
+        f"{SETTINGS['CONTENT_DIRECTORY_NAME']}/**/*",
+        lambda: event_loop.create_task(build(release=False)),
+        ignore=lambda filepath: any(
+            [
+                filepath.endswith(".md"),
+                filepath.endswith(".jinja"),
+                Path(filepath).is_dir(),
+            ]
+        ),
+    )
+    livereload_server.watch(
+        f"{SETTINGS['TEMPLATES_DIRECTORY_NAME']}/**/*",
+        lambda: rebuild_markdown_files(jinja_env),
+        ignore=lambda filepath: Path(filepath).is_dir(),
+    )
+    livereload_server.watch(
+        "./**/*.py",
+        lambda: event_loop.create_task(reload_local_plugins_and_build()),
+    )
+    livereload_server.watch(
+        "blurry.toml", lambda: event_loop.create_task(build(release=False))
+    )
+    livereload_server.serve(
+        host=SETTINGS["DEV_HOST"], port=SETTINGS["DEV_PORT"], root=get_build_directory()
+    )
+
+
+def main():
+    app()

blurry_cli-0.14.0/blurry/commands/clean.py

@@ -0,0 +1,19 @@
+import shutil
+
+from rich import print
+
+from blurry.settings import get_build_directory
+from blurry.settings import update_settings
+
+
+def clean_build_directory():
+    """Removes the build directory for a clean build."""
+    update_settings()
+    build_directory = get_build_directory()
+
+    try:
+        shutil.rmtree(build_directory)
+    except FileNotFoundError:
+        pass
+
+    print(f"Cleaned build directory: {build_directory} 🧹")

blurry_cli-0.14.0/blurry/commands/init.py

@@ -0,0 +1,135 @@
+import tomllib
+from datetime import datetime
+from pathlib import Path
+
+from rich.prompt import Prompt
+
+from blurry.settings import get_content_directory
+from blurry.settings import get_templates_directory
+from blurry.settings import update_settings
+
+
+BLURRY_CONFIG_TEMPLATE = """
+[blurry]
+domain = "{domain}"
+markdown_file_jinja_template_extension = ".jinja"
+
+[blurry.schema_data.sourceOrganization]
+name = "{project_name}"
+url = "https://{domain}"
+""".strip()
+
+HOMEPAGE_MARKDOWN = """
++++
+"@type" = "WebSite"
+name = "Home"
+abstract = "The homepage of {project_name}, built with Blurry."
+datePublished = {date_published}
++++
+
+# Welcome to your new Blurry site
+
+To learn more about how to get started, check out Blurry's quick start docs:
+
+<https://blurry-docs.netlify.app/getting-started/quick-start/>
+""".strip()
+
+BASE_TEMPLATE = """
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="color-scheme" content="light dark">
+    <link
+      rel="stylesheet"
+      href="https://cdn.jsdelivr.net/npm/@picocss/pico@2/css/pico.min.css"
+    >
+    <title>{% block title %}{% endblock %} | {{ sourceOrganization.name }}</title>
+    <meta name="description" content="{% block description %}{% endblock %}">
+    <link rel="canonical" href="{{ url }}">
+    {{ open_graph_tags|safe }}
+    {{ schema_type_tag|safe }}
+  </head>
+  <body>
+    <nav class="container">
+      <ul>
+        <li><strong>{{ sourceOrganization.name }}</strong></li>
+      </ul>
+      <ul>
+        <li><a href="/">Home</a></li>
+      </ul>
+    </nav>
+
+    <main class="container">
+      {% block body %}{% endblock %}
+    </main>
+  </body>
+</html>
+"""
+
+
+WEBSITE_TEMPLATE = """
+{% extends "base.jinja" %}
+
+{% block title %}{{ name }}{% endblock %}
+{% block description %}{{ abstract }}{% endblock %}
+
+{% block body %}
+<article>
+  {{ body|safe }}
+</article>
+{% endblock %}
+"""
+
+
+def initialize_new_project(name: str | None, domain: str | None):
+    update_settings()
+    blurry_config_file = Path("blurry.toml")
+    blurry_template_directory = get_templates_directory()
+    blurry_content_directory = get_content_directory()
+
+    if (
+        blurry_config_file.exists()
+        or blurry_template_directory.exists()
+        or blurry_content_directory.exists()
+    ):
+        print("Blurry project already initialized.")
+        return
+    name = name or Prompt.ask(
+        "What is the name of your company, project, or website?",
+    )
+    domain = domain or Prompt.ask("What is your website's domain?")
+
+    config_text = BLURRY_CONFIG_TEMPLATE.format(domain=domain, project_name=name)
+
+    try:
+        tomllib.loads(config_text)
+    except tomllib.TOMLDecodeError as e:
+        print(f"Error in configuration file: {e}.")
+        print("Please check your input and try again.")
+        exit(1)
+
+    blurry_config_file.write_text(config_text)
+
+    # Write template files
+    blurry_template_directory.mkdir(exist_ok=True)
+    base_template_file = blurry_template_directory / "base.jinja"
+    base_template_file.write_text(BASE_TEMPLATE)
+
+    website_template_file = blurry_template_directory / "WebSite.jinja"
+    website_template_file.write_text(WEBSITE_TEMPLATE)
+
+    # Write homepage Markdown file
+    date_published = datetime.now().strftime("%Y-%m-%d")
+    blurry_content_directory.mkdir(exist_ok=True)
+    homepage = blurry_content_directory / "index.md"
+    homepage.write_text(
+        HOMEPAGE_MARKDOWN.format(
+            date_published=date_published,
+            project_name=name,
+        )
+    )
+
+    print("Blurry project initialized!")
+    print("Run 'blurry runserver' to start the dev server.")

blurry_cli-0.14.0/blurry/file_processors/__init__.py

@@ -0,0 +1,164 @@
+import asyncio
+import dataclasses
+import json
+import mimetypes
+import shutil
+from copy import deepcopy
+from datetime import datetime
+from pathlib import Path
+from typing import Any
+
+from jinja2 import Environment
+from rich.console import Console
+
+from blurry.images import generate_images_for_srcset
+from blurry.open_graph import open_graph_meta_tags
+from blurry.plugins import discovered_html_plugins
+from blurry.schema_validation import validate_front_matter_as_schema
+from blurry.settings import get_build_directory
+from blurry.settings import get_content_directory
+from blurry.settings import SETTINGS
+from blurry.types import MarkdownFileData
+from blurry.types import TemplateContext
+from blurry.utils import content_path_to_url
+from blurry.utils import convert_content_path_to_directory_in_build
+from blurry.utils import format_schema_data
+from blurry.utils import write_index_file_creating_path
+
+
+warning_console = Console(stderr=True, style="bold yellow")
+
+
+def process_non_markdown_file(
+    filepath: Path, file_data_by_directory, jinja_env: Environment
+):
+    # Process Jinja files
+    if ".jinja" in filepath.suffixes:
+        process_jinja_file(filepath, jinja_env, file_data_by_directory)
+        return
+
+    CONTENT_DIR = get_content_directory()
+    mimetype, _ = mimetypes.guess_type(filepath, strict=False)
+    relative_filepath = filepath.relative_to(CONTENT_DIR)
+    output_file = get_build_directory() / relative_filepath
+
+    # Copy file to build directory if it is not already there
+    if not output_file.exists():
+        output_file.parent.mkdir(exist_ok=True, parents=True)
+        shutil.copyfile(filepath, output_file)
+
+    # Create srcset images
+    if mimetype in [
+        mimetypes.types_map[".jpg"],
+        mimetypes.types_map[".png"],
+    ]:
+        asyncio.run(generate_images_for_srcset(filepath))
+
+
+def process_jinja_file(filepath: Path, jinja_env: Environment, file_data_by_directory):
+    build_directory = get_build_directory()
+    content_directory = get_content_directory()
+    template = jinja_env.get_template(str(filepath.relative_to(content_directory)))
+    context = {
+        "file_data_by_directory": {
+            str(path): data for path, data in deepcopy(file_data_by_directory).items()
+        },
+        "settings": deepcopy(SETTINGS),
+        "datetime": datetime,
+    }
+    filepath_with_new_extension = filepath.with_suffix(
+        filepath.suffix.replace(".jinja", "")
+    )
+    filepath_in_build = build_directory / filepath_with_new_extension.relative_to(
+        content_directory
+    )
+    html = template.render(dataclasses=dataclasses, **context)
+    filepath_in_build.write_text(html)
+
+
+def json_converter_with_dates(item: Any) -> None | str:
+    if isinstance(item, datetime):
+        return item.strftime("%Y-%M-%D")
+
+
+def write_html_file(
+    filepath: Path,
+    file_data_by_directory: dict[Path, list[MarkdownFileData]],
+    release: bool,
+    jinja_env: Environment,
+):
+    extra_context: TemplateContext = {}
+    # Gather data from other files in this directory if this is an index file
+    file_data_list = file_data_by_directory[filepath.parent]
+    if filepath.name == "index.md":
+        sibling_pages = [
+            {
+                "url": content_path_to_url(f.path),
+                **f.front_matter,
+            }
+            for f in file_data_list
+            if f.path != filepath
+        ]
+        extra_context["sibling_pages"] = sibling_pages
+    folder_in_build = convert_content_path_to_directory_in_build(filepath)
+
+    file_data = [f for f in file_data_list if f.path == filepath][0]
+    schema_type = file_data.front_matter.get("@type")
+    if not schema_type:
+        raise ValueError(
+            f"Required @type value missing in file or TOML front matter invalid: "
+            f"{filepath}"
+        )
+    template_extension = SETTINGS["MARKDOWN_FILE_JINJA_TEMPLATE_EXTENSION"]
+    template = jinja_env.get_template(f"{schema_type}{template_extension}")
+
+    # Map custom template name to Schema.org type
+    if mapped_schema_type := SETTINGS["TEMPLATE_SCHEMA_TYPES"].get(schema_type):
+        file_data.front_matter["@type"] = mapped_schema_type
+
+    # Include non-schema variables as top-level context values, removing them from
+    # front_matter
+    front_matter = file_data.front_matter
+    schema_variables: TemplateContext = {}
+    template_context: TemplateContext = {}
+    non_schema_variable_prefix = SETTINGS["FRONTMATTER_NON_SCHEMA_VARIABLE_PREFIX"]
+    for key, value in front_matter.items():
+        if key.startswith(non_schema_variable_prefix):
+            template_context[key.replace(non_schema_variable_prefix, "", 1)] = value
+            continue
+        schema_variables[key] = value
+
+    schema_data = json.dumps(
+        format_schema_data(schema_variables),
+        default=json_converter_with_dates,
+    )
+
+    validate_front_matter_as_schema(filepath, schema_variables, warning_console)
+
+    schema_type_tag = f'<script type="application/ld+json">{schema_data}</script>'
+
+    template_context = {
+        "body": file_data.body,
+        "filepath": filepath,
+        "schema_data": schema_data,
+        "schema_type_tag": schema_type_tag,
+        "open_graph_tags": open_graph_meta_tags(file_data.front_matter),
+        "build_path": folder_in_build,
+        "file_data_by_directory": {
+            str(path): data for path, data in deepcopy(file_data_by_directory).items()
+        },
+        "settings": deepcopy(SETTINGS),
+        **schema_variables,
+        **deepcopy(extra_context),
+        **template_context,
+    }
+
+    html = template.render(dataclasses=dataclasses, **template_context)
+    for html_plugin in discovered_html_plugins:
+        try:
+            html = html_plugin.load()(html, template_context, release)
+        except Exception as err:
+            print(f"Error initializing plugin {html_plugin}: {err}")
+
+    # Write file
+    write_index_file_creating_path(folder_in_build, html)