rynz 1.0.0__py3-none-any.whl

rynz/__init__.py

@@ -0,0 +1,25 @@
+#!/bin/python
+
+#
+#       ███╗   ██╗██╗██╗  ██╗ █████╗ ██████╗ ███████╗
+#       ████╗  ██║██║██║  ██║██╔══██╗██╔══██╗██╔════╝
+#       ██╔██╗ ██║██║███████║███████║██████╔╝███████╗
+#       ██║╚██╗██║██║██╔══██║██╔══██║██╔══██╗╚════██║
+#       ██║ ╚████║██║██║  ██║██║  ██║██║  ██║███████║
+#       ╚═╝  ╚═══╝╚═╝╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝╚══════╝
+#       DRAFTED BY [https://nih.ar] ON 14-04-2025
+#       SOURCE [__init__.py] LAST MODIFIED ON 28-04-2025.
+#
+
+"""
+Module for versioning of the rynz package.
+
+This module defines the version number for the rynz static site generator
+and provides a function to retrieve the current version.
+"""
+
+__version__ = "1.0.0"
+
+def get_version():
+    """Returns the current version of the rynz package."""
+    return __version__

rynz/builder.py

@@ -0,0 +1,242 @@
+#!/bin/python
+
+#
+#       ███╗   ██╗██╗██╗  ██╗ █████╗ ██████╗ ███████╗
+#       ████╗  ██║██║██║  ██║██╔══██╗██╔══██╗██╔════╝
+#       ██╔██╗ ██║██║███████║███████║██████╔╝███████╗
+#       ██║╚██╗██║██║██╔══██║██╔══██║██╔══██╗╚════██║
+#       ██║ ╚████║██║██║  ██║██║  ██║██║  ██║███████║
+#       ╚═╝  ╚═══╝╚═╝╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝╚══════╝
+#       DRAFTED BY [https://nih.ar] ON 28-04-2025
+#       SOURCE [builder.py] LAST MODIFIED ON 28-04-2025.
+#
+
+from shutil import copytree, rmtree
+from os import path, makedirs, sep
+from glob import glob
+from yaml import safe_load
+from jinja2 import Environment, FileSystemLoader
+from markdown2 import markdown
+from time import time
+from rich.console import Console
+from rich.panel import Panel
+from rich.table import Table
+
+# Initialize console for colorful output
+console = Console()
+
+
+def print_message(message, style="info"):
+    """
+    Prints a styled message using the Rich console.
+
+    Args:
+        message (str): The message to display.
+        style (str): Message style ("success", "error", or "info").
+    """
+    styles = {
+        "success": "bold green",
+        "error": "bold red",
+        "info": "yellow"
+    }
+    console.print(message, style=styles.get(style, "yellow"))
+
+def buildRynz():
+    """
+    Builds the static site by converting Markdown notes into HTML pages,
+    using Jinja2 templates and configuration from config.yml.
+    """
+    start_time = time()
+    total_notes = 0
+    failed_notes = 0
+    skipped_notes = []
+
+    console.rule("[bold green]🔨 Starting Build Process")
+    
+    def readmd(filepath):
+        """
+        Reads and returns the raw content of a markdown file.
+
+        Args:
+            filepath (str): Path to the markdown file.
+
+        Returns:
+            str: File content as a string.
+        """
+        try:
+            with open(filepath, 'r', encoding='utf8', errors='ignore') as data:
+                return data.read()
+        except Exception as e:
+            print_message(f"❌ Error reading {filepath}: {e}", "error")
+            return ""
+
+
+    def create_page(template, post_detail, md_content, filename):
+        """
+        Renders and writes a page from a Jinja2 template and given content.
+        Handles both single notes and special pages like index.html and RSS feeds.
+
+        Args:
+            template (str): Template filename.
+            post_detail (dict): Frontmatter details for the post.
+            md_content (str): Markdown content to render.
+            filename (str): Output filename.
+
+        Returns:
+            str: Rendered file name or an empty string in case of error.
+        """
+        
+        try:
+            env = Environment(loader=FileSystemLoader(searchpath='./'))
+            template_obj = env.get_template(template)
+
+            # Initialize variables
+            post_title = ""
+            post_subtitle = ""
+            post_date = ""
+            post_meta = ""
+            posts_list = ""
+            last_date = ""
+            post_data = filename.split(sep)
+            post_path = home_path
+			
+            # Determine post details based on the filename
+            if filename == "index.html":
+                post_file = filename
+                posts_list = posts
+            elif filename.endswith(".xml"):
+                post_file = filename
+                posts_list = posts
+                last_date = posts_list[0].get('date')
+            elif post_detail is None:
+                post_file = filename.replace('.md', '.html')
+            else:
+                post_title = post_detail.get("title", "")
+                post_subtitle = post_detail.get("subtitle", "")
+                post_date = post_detail.get("date", "")
+                post_meta = post_detail.get("meta", "")
+                post_data = filename.split(sep)
+                post_path = path.join(home_path)
+                post_file = post_data[2].replace('.md', '.html')
+                post_data = post_data[1]
+                makedirs(post_path, exist_ok=True)
+
+            output_filepath = path.join(post_path, post_file)
+            with open(output_filepath, 'w', encoding='utf8', errors='ignore') as output_file:
+                output_file.write(
+                    template_obj.render(
+                        title=title,
+                        post_title=post_title,
+                        post_subtitle=post_subtitle,
+                        date=post_date,
+                        metad=post_meta,
+                        url=path.join(url, post_file),
+                        article=markdown(md_content),
+                        posts=posts_list,
+                        home=home_md,
+                        header=markdown(readmd(header_md)),
+                        footer=markdown(readmd(footer_md)),
+                        last_date=last_date,
+                        config=config
+                    )
+                )
+            return post_file
+        except Exception as e:
+            print_message(f"❌ Error creating page {filename}: {e}", "error")
+            return ""
+    
+    try:
+        # Load configuration
+        with open('config.yml', encoding='utf8', errors='ignore') as conf_file:
+            config = safe_load(conf_file.read())
+
+        # Set config values as globals
+        for key, val in config.items():
+            globals()[key] = val
+
+        # Ensure all required configuration keys are present
+        required_keys = [
+            'home_path', 'resource_path', 'content_path', 'note_template',
+            'home_template', 'feed_template', 'home_md', 'header_md',
+            'footer_md', 'title', 'url'
+        ]
+        for key in required_keys:
+            if key not in config:
+                print_message(f"❌ Missing config key: {key}", "error")
+                return
+
+        # Reset output directory
+        if path.exists(home_path):
+            rmtree(home_path)
+        copytree(resource_path, home_path)
+
+        posts = []
+
+        # Process each note
+        for note_path in glob(path.join(content_path, "note", "*.md")):
+            try:
+                yaml_lines = []
+                frontmatter, markdown_content = '', ''
+
+                # Read frontmatter and body
+                with open(note_path, encoding='utf8', errors='ignore') as infile:
+                    for line in infile:
+                        if line.startswith('---'):
+                            for line in infile:
+                                if line.startswith('---'):
+                                    break
+                                yaml_lines.append(line)
+                            frontmatter = ''.join(yaml_lines)
+                            markdown_content = ''.join(infile)
+                            break
+
+                post_detail = safe_load(frontmatter)
+
+                if post_detail is not None:
+                    # Build the note page
+                    post_url = create_page(
+                        note_template, post_detail, markdown_content, note_path
+                    )
+
+                    # Add to posts list for homepage/rss
+                    post_entry = post_detail
+                    post_entry.update({'url': '/' + post_url})
+                    post_entry.update({'note': markdown(markdown_content)})
+                    posts.append(post_entry)
+
+                    total_notes += 1
+                    print_message(f"✔ Built: {post_url}", "success")
+                else:
+                    # If no valid frontmatter found
+                    skipped_notes.append(note_path)
+                    print_message(f"⚠️ Skipped: No frontmatter in {note_path}", "info")
+            except Exception:
+                failed_notes += 1
+                print_message(f"❌ Error in: {note_path}", "error")
+                console.print_exception()
+
+        # Sort posts by latest date
+        posts = sorted(posts, key=lambda post: post.get('date', ''), reverse=True)
+
+        # Build index.html and RSS feed
+        create_page(home_template, None, readmd(home_md), "index.html")
+        create_page(feed_template, None, readmd(home_md), "rss.xml")
+
+        # Build summary table
+        console.rule("[bold cyan]✅ Build Summary")
+        summary = Table(show_header=True, header_style="bold magenta")
+        summary.add_column("Metric")
+        summary.add_column("Count", justify="right")
+        summary.add_row("Notes Processed", str(total_notes))
+        summary.add_row("Skipped Notes", str(len(skipped_notes)))
+        summary.add_row("Failed Notes", str(failed_notes))
+        summary.add_row("Time Taken (s)", f"{(time() - start_time):.2f}")
+        console.print(summary)
+
+    except Exception:
+        console.print(Panel(
+            "[bold red]Something went wrong while building your site![/bold red]\n\n"
+            "[italic]Make sure you're inside a valid Rynz directory.[/italic]",
+            title="❌ Build Failed"
+        ))
+        console.print_exception()

rynz/creator.py

@@ -0,0 +1,410 @@
+#!/bin/python3
+
+#
+#       ███╗   ██╗██╗██╗  ██╗ █████╗ ██████╗ ███████╗
+#       ████╗  ██║██║██║  ██║██╔══██╗██╔══██╗██╔════╝
+#       ██╔██╗ ██║██║███████║███████║██████╔╝███████╗
+#       ██║╚██╗██║██║██╔══██║██╔══██║██╔══██╗╚════██║
+#       ██║ ╚████║██║██║  ██║██║  ██║██║  ██║███████║
+#       ╚═╝  ╚═══╝╚═╝╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝╚══════╝
+#       DRAFTED BY [https://nih.ar] ON 18-04-2021.
+#       SOURCE [creator.py] LAST MODIFIED ON 15-04-2025.
+#
+
+from os import mkdir, path, makedirs
+from datetime import datetime
+import sys
+from rich.console import Console
+
+# Initialize console for colorful output
+console = Console()
+
+
+def print_message(message, style="info", timestamp=False):
+    """
+    Prints a styled message using the Rich console.
+
+    Args:
+        message (str): The message to display.
+        style (str): Message style ("success", "error", or "info").
+        timestamp (bool): Whether to include a timestamp in the message.
+    """
+    styles = {
+        "success": "bold green",
+        "error": "bold red",
+        "info": "yellow"
+    }
+    if timestamp:
+        current_time = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+        message = f"[{current_time}] {message}"
+    console.print(message, style=styles.get(style, "yellow"))
+
+
+def get_input(prompt, default_value, validator=None):
+    """
+    Prompts user for input with an optional default and validator.
+
+    Args:
+        prompt (str): The input prompt.
+        default_value (str): Default input value if the user provides none.
+        validator (callable): A function to validate input (optional).
+
+    Returns:
+        str: The validated user input.
+    """
+    while True:
+        user_input = input(prompt).strip() or default_value
+        if validator and not validator(user_input):
+            print_message(
+                "Invalid input. Please try again.", "error", timestamp=True
+            )
+        else:
+            return user_input
+
+
+def is_valid_url(url):
+    """
+    Checks if the given string contains a basic valid domain structure.
+
+    Args:
+        url (str): The URL string to validate.
+
+    Returns:
+        bool: True if the URL is valid, False otherwise.
+    """
+    return "." in url
+
+
+def safe_create_directory(directory):
+    """
+    Safely creates a directory if it doesn't already exist.
+
+    Args:
+        directory (str): Path to the directory to create.
+
+    Exits:
+        On failure to create the directory.
+    """
+    try:
+        if not path.exists(directory):
+            makedirs(directory)
+            print_message(
+                f"Created directory: {directory}", "success", timestamp=True
+            )
+        else:
+            print_message(
+                f"Directory already exists: {directory}", "info", timestamp=True
+            )
+    except Exception as e:
+        print_message(
+            f"❌ Error creating directory {directory}: {e}", "error", timestamp=True
+        )
+        sys.exit(1)
+
+
+def createConfig(rynzName):
+    """
+    Creates the default configuration file `config.yml`.
+
+    Args:
+        rynzName (str): The name of the project directory.
+    """
+    try:
+        with open(path.join(rynzName, 'config.yml'), 'w') as f:
+            title = rynzName
+            url = 'yourdomain.tld'
+
+            conf_data = f"""
+# Mandatory Configuration
+title: {title}
+url: {url}
+note_template: template/note_template.html
+home_template: template/home_template.html
+feed_template: template/feed_template.xml
+home_path: public
+content_path: content
+resource_path: static
+home_md: content/home.md
+header_md: content/header.md
+footer_md: content/footer.md
+
+# Optional Configuration
+site-title: {title}
+css: demo.css
+desc: Write anything that human and machine can understand.
+mail: some@mail.com
+"""
+            f.write(conf_data)
+            print_message("config.yml created.", "success", timestamp=True)
+    except Exception as e:
+        print_message(
+            f"❌ Error creating config.yml: {e}", "error", timestamp=True
+        )
+
+
+def createTemplate(rynzName, template_type, file_content):
+    """
+    Creates a template file with the provided content.
+
+    Args:
+        rynzName (str): The name of the project directory.
+        template_type (str): The name of the template file.
+        file_content (str): The content to write to the template file.
+    """
+    try:
+        template_file_path = path.join(rynzName, 'template', template_type)
+        with open(template_file_path, 'w') as f:
+            f.write(file_content)
+            print_message(
+                f"{template_type} created.", "success", timestamp=True
+            )
+    except Exception as e:
+        print_message(
+            f"❌ Error creating {template_type}: {e}", "error", timestamp=True
+        )
+
+# Template: Home Page
+home_template_content = """
+<!DOCTYPE html>
+<html lang="en-IN" data-theme="dark">
+<head>
+<meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content=" {{ config.get('desc') }} ">
+<title>{{ config.get('site-title') }}</title>
+<link rel="stylesheet" href="{{ config.get('css') }}">
+<link rel="alternate" type="application/atom+xml" title="Recent blog posts" href="/rss.xml">
+</head>
+<body>
+<header>
+<h1><a href="/">{{ title | lower }}</a></h1>
+{{ header }}
+</header>
+<section>
+{{ article }}
+<ul>
+{% for post in posts %}
+  {% if "note" in post.tags %}
+    <li>{{ post.date.strftime('%d %m %Y') }} ; <a href="{{ post.url }}">{{ post.title | lower }}</a></li>
+  {% endif %}
+{% endfor %}
+{% if nextpage %} <a href="{{ nextpage }}">Older Notes >> </a> {% endif %}
+</ul>
+</section>
+<footer>
+{{ footer }}
+</footer>
+</body>
+</html>
+"""
+
+# Template: Note Page
+note_template_content = """
+<!DOCTYPE html>
+<html lang="en" data-theme="dark">
+<head>
+<meta charset="utf-8">
+<title>{{ post_title }}</title>
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content=" {{ post_subtitle }} ">
+<link rel="stylesheet" href="{{ config.get('css') }}">
+<link rel="alternate" type="application/atom+xml" title="Recent blog posts" href="/rss.xml">
+</head>
+<body>
+<header>
+<h1>{{ post_title }}</h1>
+</header>
+<article>
+{{ article }}
+{% if date %}
+<p># Last updated on <time>{{ date.strftime('%d %b %Y') }}.</time></p>
+{% endif %}
+</article>
+<footer>
+{{ footer }}
+</footer>
+</body>
+</html>
+"""
+
+# Template: Feed (RSS)
+feed_template_content = """
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+  <channel>
+    <title>{{ title }}</title>
+    <atom:link href="{{ url }}" rel="self" type="application/rss+xml" />
+    <link>{{ url }}</link>
+    <description>{{ subtitle }}</description>
+    <lastBuildDate>{{ last_date.strftime('%a, %d %b %Y %H:%M:%S GMT') }}</lastBuildDate>
+    <language>en-IN</language>
+    <image>
+      <url>{{ config.get('url') }}/{{ config.get('pht') }}</url>
+      <title>{{ title }}</title>
+      <link>{{ url }}</link>
+      <width>32</width>
+      <height>32</height>
+    </image>
+    {% for post in posts %}
+        {% if "note" in post.tags %}
+            <item>
+            <title>{{ post.title }}</title>
+            <link>{{ config.get('url') }}{{ post.url }}</link>
+            <pubDate>{{ post.date.strftime('%a, %d %b %Y %H:%M:%S GMT') }}</pubDate>
+            <guid isPermaLink="false">{{ config.get('url') }}{{ post.url }}</guid>
+            <description><![CDATA[{{ post.subtitle }} - {{ post.note }} ]]></description>
+            </item>
+        {% endif %}
+    {% endfor %}
+  </channel>
+</rss>
+"""
+
+# Create content/header/footer/note   
+def createContent(rynzName):
+    """
+    Creates initial content, including `header.md`, `footer.md`, and `home.md`.
+
+    Args:
+        rynzName (str): The name of the project directory.
+    """
+    try:
+        safe_create_directory(path.join(rynzName, 'content', 'note'))
+
+        with open(path.join(rynzName, 'content', 'header.md'), 'w') as f:
+            f.write(
+                "*   [Home](/)\n*   [Other Links](/)\n"
+                "*   [Edit content/header.md](/)"
+            )
+            print_message("header.md created.", "success", timestamp=True)
+
+        with open(path.join(rynzName, 'content', 'footer.md'), 'w') as f:
+            f.write(
+                "*   [Home](/)\n*   [RSS](/)\n"
+                "*   [Edit content/footer.md](/)\n"
+                "*   powered by [Rynz](https://rynz.de)"
+            )
+            print_message("footer.md created.", "success", timestamp=True)
+
+        with open(path.join(rynzName, 'content', 'home.md'), 'w') as f:
+            f.write(
+                "Welcome to Rynz.\nThis is a sample homepage which can be "
+                "edited at /content/home.md"
+            )
+            print_message("home.md created.", "success", timestamp=True)
+
+        # Ensure the note directory exists before calling createNote
+        note_dir = path.join(rynzName, 'content', 'note')
+        safe_create_directory(note_dir)
+
+        # Generate a sample note
+        createNote("notepage1.md", rynzName)
+
+    except Exception as e:
+        print_message(f"❌ Error creating content: {e}", "error", timestamp=True)
+        
+
+def createNote(noteName, rynzName=''):
+    """
+    Creates a markdown note file with sample content.
+
+    Args:
+        noteName (str): Name of the note file to create.
+        rynzName (str): Parent directory for the note file. Defaults to ''.
+    """
+    try:
+        note_dir = path.join(rynzName, 'content', 'note')
+
+        # Ensure the directory exists
+        if not path.exists(note_dir):
+            makedirs(note_dir)
+
+        if not noteName.lower().endswith('.md'):
+            noteName += '.md'
+
+        with open(path.join(note_dir, noteName), 'w') as f:
+            conf_data = (
+                """---
+title: "Sample Note Page."
+subtitle: "Sample subtitle"
+date: {t}
+tags: [note,generic]
+---
+
+# This is a sample note page which can be edited/renamed at /content/note/{noteName}
+# This is heading 1
+
+## This is heading 2
+
+### This is heading 3
+
+#### This is heading 4
+
+##### This is heading 5
+
+###### This is heading 6
+
+**Bold**
+
+*italic*
+
+* list
+* list
+
+1. ordered list
+2. ordered list
+
+[link](/)
+
+Sample paragraph is written like this with lorem ipsum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+            """).format(t=datetime.now().strftime("%Y-%m-%d"), noteName=noteName)
+
+            f.write(conf_data)
+            print_message(
+                f"{noteName} is created at {path.join(note_dir, noteName)}",
+                "success",
+                timestamp=True
+            )
+
+    except Exception as e:
+        print_message(
+            f"While generating page {noteName}, some issue occurred: {e}",
+            "error",
+            timestamp=True
+        )
+
+
+def createRynz(rynzName):
+    """
+    Initializes a Rynz project with all necessary directories and files.
+
+    Args:
+        rynzName (str): The name of the project directory.
+    """
+    try:
+        safe_create_directory(rynzName)
+        safe_create_directory(path.join(rynzName, 'template'))
+        safe_create_directory(path.join(rynzName, 'static'))
+        safe_create_directory(path.join(rynzName, 'content'))
+        safe_create_directory(path.join(rynzName, 'content', 'note'))
+
+        createConfig(rynzName)
+        createTemplate(rynzName, 'home_template.html', home_template_content)
+        createTemplate(rynzName, 'note_template.html', note_template_content)
+        createTemplate(rynzName, 'feed_template.xml', feed_template_content)
+        createContent(rynzName)
+
+        print_message(
+            f"Rynz project {rynzName} created successfully!", "success",
+            timestamp=True
+        )
+
+    except Exception as e:
+        print_message(
+            f"❌ Error creating Rynz project {rynzName}: {e}", "error",
+            timestamp=True
+        )
+        sys.exit(1)