blurry-cli 0.22.0__tar.gz

blurry_cli-0.22.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 John Franey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

blurry_cli-0.22.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: blurry-cli
+Version: 0.22.0
+Summary: A Mistune-based static site generator for Python
+License: MIT
+License-File: LICENSE
+Keywords: static-site-generator,seo,pagespeed
+Author: John Franey
+Author-email: franey@duck.com
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System
+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.1.5,<4.0.0)
+Requires-Dist: PyLD (>=2.0.4,<3.0.0)
+Requires-Dist: dpath (>=2.2.0,<3.0.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.64)
+Requires-Dist: livereload (>=2.7.1,<3.0.0)
+Requires-Dist: mistune (>=3.1.0,<4.0.0)
+Requires-Dist: pillow (>=12.0.0,<13.0.0)
+Requires-Dist: pydantic (>=2.10.5,<3.0.0)
+Requires-Dist: pymediainfo (>=7.0.1,<8.0.0)
+Requires-Dist: rich (>=13.9.4,<15.0.0)
+Requires-Dist: selectolax (>=0.3.27,<0.5.0)
+Requires-Dist: typer (>=0.15.1,<0.22.0)
+Project-URL: Repository, https://github.com/blurry-dev/blurry
+Description-Content-Type: text/markdown
+
+# Blurry
+
+[![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](https://github.com/blurry-dev/blurry/raw/main/docs/content/favicon.png)
+
+## tl;dr
+
+Blurry is a schema-first, plugin-enabled static site generator.
+Markdown front matter directly to [Schema.org types](https://schema.org/docs/full.html), so your content is SEO-friendly and [rich results-ready](https://developers.google.com/search/docs/appearance/structured-data/search-gallery) out of the box.
+
+Blurry also makes your images responsive, supports embedding Python source code in Markdown files, and more.
+
+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/>.
+
+## Contributing
+
+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:
+
+- [Mistune](https://mistune.readthedocs.io/) to convert Markdown to HTML
+- [Jinja](https://jinja.palletsprojects.com/) for HTML templating
+- [JinjaX](https://jinjax.scaletti.dev/) for Jinja components
+- [LiveReload](https://livereload.readthedocs.io/) for an HTTP server with automatic browser reloading
+- [Typer](https://typer.tiangolo.com/) for its CLI interface
+- [Pillow](https://pillow.readthedocs.io/en/stable/)
+
+&copy; 2020-present, John Franey
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=blurry-dev/blurry&type=date&legend=top-left)](https://www.star-history.com/#blurry-dev/blurry&type=date&legend=top-left)
+

blurry_cli-0.22.0/README.md

@@ -0,0 +1,51 @@
+# Blurry
+
+[![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](https://github.com/blurry-dev/blurry/raw/main/docs/content/favicon.png)
+
+## tl;dr
+
+Blurry is a schema-first, plugin-enabled static site generator.
+Markdown front matter directly to [Schema.org types](https://schema.org/docs/full.html), so your content is SEO-friendly and [rich results-ready](https://developers.google.com/search/docs/appearance/structured-data/search-gallery) out of the box.
+
+Blurry also makes your images responsive, supports embedding Python source code in Markdown files, and more.
+
+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/>.
+
+## Contributing
+
+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:
+
+- [Mistune](https://mistune.readthedocs.io/) to convert Markdown to HTML
+- [Jinja](https://jinja.palletsprojects.com/) for HTML templating
+- [JinjaX](https://jinjax.scaletti.dev/) for Jinja components
+- [LiveReload](https://livereload.readthedocs.io/) for an HTTP server with automatic browser reloading
+- [Typer](https://typer.tiangolo.com/) for its CLI interface
+- [Pillow](https://pillow.readthedocs.io/en/stable/)
+
+&copy; 2020-present, John Franey
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=blurry-dev/blurry&type=date&legend=top-left)](https://www.star-history.com/#blurry-dev/blurry&type=date&legend=top-left)

blurry_cli-0.22.0/blurry/__init__.py

@@ -0,0 +1,227 @@
+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.commands.version import print_blurry_version
+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 get_settings
+from blurry.settings import update_settings
+from blurry.sitemap import write_sitemap_file
+from blurry.templates import get_jinja_env
+from blurry.utils import handle_future_result
+
+
+warning_console = Console(stderr=True, style="bold yellow")
+
+
+app = AsyncTyper(no_args_is_help=True)
+
+
+@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.command(name="version")
+def version_command():
+    print_blurry_version()
+
+
+@app.async_command()
+async def build(release=True, clean: bool = False):
+    """Generates HTML content from Markdown files."""
+    start = datetime.now()
+
+    if release:
+        update_settings()
+        print_blurry_name()
+        print_plugin_table()
+
+    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 future: handle_future_result(
+                    future,
+                    "Could not generate sitemap",
+                )
+            )
+            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()
+
+    SETTINGS = get_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))
+    )
+
+    for header_name, header_value in SETTINGS["DEV_HEADERS"].items():
+        livereload_server.setHeader(header_name, header_value)
+
+    livereload_server.serve(
+        host=SETTINGS["DEV_HOST"], port=SETTINGS["DEV_PORT"], root=get_build_directory()
+    )
+
+
+def main():
+    app()

blurry_cli-0.22.0/blurry/__main__.py

@@ -0,0 +1,3 @@
+from blurry import main
+
+main()

blurry_cli-0.22.0/blurry/async_typer.py

@@ -0,0 +1,20 @@
+import asyncio
+from functools import wraps
+
+from typer import Typer
+
+
+class AsyncTyper(Typer):
+    def async_command(self, *args, **kwargs):
+        def decorator(async_func):
+            # Convert async function to synchronous
+            @wraps(async_func)
+            def sync_func(*_args, **_kwargs):
+                return asyncio.run(async_func(*_args, **_kwargs))
+
+            # Register synchronous function
+            self.command(*args, **kwargs)(sync_func)
+
+            return async_func
+
+        return decorator

blurry_cli-0.22.0/blurry/cli.py

@@ -0,0 +1,37 @@
+from rich.console import Console
+from rich.table import Table
+
+from blurry.plugins import discovered_html_plugins
+from blurry.plugins import discovered_jinja_extensions
+from blurry.plugins import discovered_jinja_filter_plugins
+from blurry.plugins import discovered_markdown_plugins
+
+console = Console()
+
+
+def print_blurry_name():
+    console.print(
+        """
+.  .             
+|-.| . ..-..-.. .
+`-''-'-''  '  '-|
+              `-'
+    """.strip()
+    )
+
+
+def print_plugin_table():
+    plugin_table = Table(show_header=True)
+    plugin_table.add_column("Markdown Plugins")
+    plugin_table.add_column("HTML Plugins")
+    plugin_table.add_column("Jinja Plugins")
+    plugin_table.add_row(
+        "\n".join([p.name for p in discovered_markdown_plugins]),
+        "\n".join([p.name for p in discovered_html_plugins]),
+        "\n".join(
+            [p.name for p in discovered_jinja_filter_plugins]
+            + [p.name for p in discovered_jinja_extensions]
+        ),
+    )
+
+    console.print(plugin_table)

blurry_cli-0.22.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.22.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.22.0/blurry/commands/version.py

@@ -0,0 +1,9 @@
+import importlib.metadata
+from rich import print
+
+
+def print_blurry_version():
+    """Prints the current Blurry version."""
+    version = importlib.metadata.version("blurry-cli")
+
+    print(f"v{version}")

blurry_cli-0.22.0/blurry/constants.py

@@ -0,0 +1,7 @@
+from pathlib import Path
+
+ENV_VAR_PREFIX = "BLURRY_"
+
+SETTINGS_FILENAME = "blurry.toml"
+
+CURR_DIR = Path.cwd()