ophinode 0.0.1a1__py3-none-any.whl

ophinode/__init__.py

@@ -0,0 +1,490 @@
+"A static-site and page generator for Python."
+
+__author__ = "deflatedlatte"
+__all__ = [
+    "Site",
+    "render_page",
+    "ClosedRenderable",
+    "OpenRenderable",
+    "Expandable",
+    "Preparable",
+    "Page",
+    "Layout",
+    "HTML5Page",
+    "HTML5Layout",
+    "Node",
+    "TextNode",
+    "HTML5Doctype",
+    "CDATASection",
+    "Comment",
+    "Element",
+    "OpenElement",
+    "ClosedElement",
+    "HtmlElement",
+    "HeadElement",
+    "TitleElement",
+    "BaseElement",
+    "LinkElement",
+    "MetaElement",
+    "StyleElement",
+    "BodyElement",
+    "ArticleElement",
+    "SectionElement",
+    "NavigationElement",
+    "AsideElement",
+    "HeadingLevel1Element",
+    "HeadingLevel2Element",
+    "HeadingLevel3Element",
+    "HeadingLevel4Element",
+    "HeadingLevel5Element",
+    "HeadingLevel6Element",
+    "HeadingGroupElement",
+    "HeaderElement",
+    "FooterElement",
+    "AddressElement",
+    "ParagraphElement",
+    "HorizontalRuleElement",
+    "PreformattedTextElement",
+    "BlockQuotationElement",
+    "OrderedListElement",
+    "UnorderedListElement",
+    "MenuElement",
+    "ListItemElement",
+    "DescriptionListElement",
+    "DescriptionTermElement",
+    "DescriptionDetailsElement",
+    "FigureElement",
+    "FigureCaptionElement",
+    "MainElement",
+    "SearchElement",
+    "DivisionElement",
+    "AnchorElement",
+    "EmphasisElement",
+    "StrongImportanceElement",
+    "SmallPrintElement",
+    "StrikethroughElement",
+    "CitationElement",
+    "QuotationElement",
+    "DefinitionElement",
+    "AbbreviationElement",
+    "RubyAnnotationElement",
+    "RubyTextElement",
+    "RubyParenthesesElement",
+    "DataElement",
+    "TimeElement",
+    "CodeElement",
+    "VariableElement",
+    "SampleElement",
+    "KeyboardInputElement",
+    "SubscriptElement",
+    "SuperscriptElement",
+    "ItalicTextElement",
+    "BoldTextElement",
+    "UnarticulatedAnnotationElement",
+    "MarkedTextElement",
+    "BidirectionalIsolateElement",
+    "BidirectionalOverrideElement",
+    "SpanElement",
+    "LineBreakElement",
+    "LineBreakOpportunityElement",
+    "InsertionElement",
+    "DeletionElement",
+    "PictureElement",
+    "SourceElement",
+    "ImageElement",
+    "InlineFrameElement",
+    "EmbeddedContentElement",
+    "ExternalObjectElement",
+    "VideoElement",
+    "AudioElement",
+    "TextTrackElement",
+    "ImageMapElement",
+    "ImageMapAreaElement",
+    "TableElement",
+    "TableCaptionElement",
+    "TableColumnGroupElement",
+    "TableColumnElement",
+    "TableBodyElement",
+    "TableHeadElement",
+    "TableFootElement",
+    "TableRowElement",
+    "TableDataCellElement",
+    "TableHeaderCellElement",
+    "FormElement",
+    "LabelElement",
+    "InputElement",
+    "ButtonElement",
+    "SelectElement",
+    "DataListElement",
+    "OptionGroupElement",
+    "OptionElement",
+    "TextAreaElement",
+    "OutputElement",
+    "ProgressElement",
+    "MeterElement",
+    "FieldSetElement",
+    "FieldSetLegendElement",
+    "DetailsElement",
+    "SummaryElement",
+    "DialogElement",
+    "ScriptElement",
+    "NoScriptElement",
+    "TemplateElement",
+    "SlotElement",
+    "CanvasElement",
+    "Html",
+    "Head",
+    "Title",
+    "Base",
+    "Link",
+    "Meta",
+    "Style",
+    "Body",
+    "Article",
+    "Section",
+    "Nav",
+    "Aside",
+    "H1",
+    "H2",
+    "H3",
+    "H4",
+    "H5",
+    "H6",
+    "HGroup",
+    "Header",
+    "Footer",
+    "Address",
+    "P",
+    "HR",
+    "Pre",
+    "BlockQuote",
+    "OL",
+    "UL",
+    "Menu",
+    "LI",
+    "DL",
+    "DT",
+    "DD",
+    "Figure",
+    "FigCaption",
+    "Main",
+    "Search",
+    "Div",
+    "A",
+    "EM",
+    "Strong",
+    "Small",
+    "S",
+    "Cite",
+    "Q",
+    "Dfn",
+    "Abbr",
+    "Ruby",
+    "RT",
+    "RP",
+    "Data",
+    "Time",
+    "Code",
+    "Var",
+    "Samp",
+    "Kbd",
+    "Sub",
+    "Sup",
+    "I",
+    "B",
+    "U",
+    "Mark",
+    "BDI",
+    "BDO",
+    "Span",
+    "BR",
+    "WBR",
+    "Ins",
+    "Del",
+    "Picture",
+    "Source",
+    "Image",
+    "IFrame",
+    "Embed",
+    "Object",
+    "Video",
+    "Audio",
+    "Track",
+    "Map",
+    "Area",
+    "Table",
+    "Caption",
+    "ColGroup",
+    "Column",
+    "TBody",
+    "THead",
+    "TFoot",
+    "TR",
+    "TD",
+    "TH",
+    "Form",
+    "Label",
+    "Input",
+    "Button",
+    "Select",
+    "DataList",
+    "OptGroup",
+    "Option",
+    "Progress",
+    "Meter",
+    "FieldSet",
+    "Legend",
+    "Details",
+    "Summary",
+    "Dialog",
+    "Script",
+    "NoScript",
+    "Template",
+    "Slot",
+    "Canvas",
+]
+
+from .site import Site, render_page
+from .nodes.base import (
+    ClosedRenderable,
+    OpenRenderable,
+    Expandable,
+    Preparable,
+    Page,
+    Layout,
+)
+from .nodes.html import (
+    HTML5Page,
+    HTML5Layout,
+    Node,
+    TextNode,
+    HTML5Doctype,
+    CDATASection,
+    Comment,
+    Element,
+    OpenElement,
+    ClosedElement,
+    HtmlElement,
+    HeadElement,
+    TitleElement,
+    BaseElement,
+    LinkElement,
+    MetaElement,
+    StyleElement,
+    BodyElement,
+    ArticleElement,
+    SectionElement,
+    NavigationElement,
+    AsideElement,
+    HeadingLevel1Element,
+    HeadingLevel2Element,
+    HeadingLevel3Element,
+    HeadingLevel4Element,
+    HeadingLevel5Element,
+    HeadingLevel6Element,
+    HeadingGroupElement,
+    HeaderElement,
+    FooterElement,
+    AddressElement,
+    ParagraphElement,
+    HorizontalRuleElement,
+    PreformattedTextElement,
+    BlockQuotationElement,
+    OrderedListElement,
+    UnorderedListElement,
+    MenuElement,
+    ListItemElement,
+    DescriptionListElement,
+    DescriptionTermElement,
+    DescriptionDetailsElement,
+    FigureElement,
+    FigureCaptionElement,
+    MainElement,
+    SearchElement,
+    DivisionElement,
+    AnchorElement,
+    EmphasisElement,
+    StrongImportanceElement,
+    SmallPrintElement,
+    StrikethroughElement,
+    CitationElement,
+    QuotationElement,
+    DefinitionElement,
+    AbbreviationElement,
+    RubyAnnotationElement,
+    RubyTextElement,
+    RubyParenthesesElement,
+    DataElement,
+    TimeElement,
+    CodeElement,
+    VariableElement,
+    SampleElement,
+    KeyboardInputElement,
+    SubscriptElement,
+    SuperscriptElement,
+    ItalicTextElement,
+    BoldTextElement,
+    UnarticulatedAnnotationElement,
+    MarkedTextElement,
+    BidirectionalIsolateElement,
+    BidirectionalOverrideElement,
+    SpanElement,
+    LineBreakElement,
+    LineBreakOpportunityElement,
+    InsertionElement,
+    DeletionElement,
+    PictureElement,
+    SourceElement,
+    ImageElement,
+    InlineFrameElement,
+    EmbeddedContentElement,
+    ExternalObjectElement,
+    VideoElement,
+    AudioElement,
+    TextTrackElement,
+    ImageMapElement,
+    ImageMapAreaElement,
+    TableElement,
+    TableCaptionElement,
+    TableColumnGroupElement,
+    TableColumnElement,
+    TableBodyElement,
+    TableHeadElement,
+    TableFootElement,
+    TableRowElement,
+    TableDataCellElement,
+    TableHeaderCellElement,
+    FormElement,
+    LabelElement,
+    InputElement,
+    ButtonElement,
+    SelectElement,
+    DataListElement,
+    OptionGroupElement,
+    OptionElement,
+    TextAreaElement,
+    OutputElement,
+    ProgressElement,
+    MeterElement,
+    FieldSetElement,
+    FieldSetLegendElement,
+    DetailsElement,
+    SummaryElement,
+    DialogElement,
+    ScriptElement,
+    NoScriptElement,
+    TemplateElement,
+    SlotElement,
+    CanvasElement,
+    Html,
+    Head,
+    Title,
+    Base,
+    Link,
+    Meta,
+    Style,
+    Body,
+    Article,
+    Section,
+    Nav,
+    Aside,
+    H1,
+    H2,
+    H3,
+    H4,
+    H5,
+    H6,
+    HGroup,
+    Header,
+    Footer,
+    Address,
+    P,
+    HR,
+    Pre,
+    BlockQuote,
+    OL,
+    UL,
+    Menu,
+    LI,
+    DL,
+    DT,
+    DD,
+    Figure,
+    FigCaption,
+    Main,
+    Search,
+    Div,
+    A,
+    EM,
+    Strong,
+    Small,
+    S,
+    Cite,
+    Q,
+    Dfn,
+    Abbr,
+    Ruby,
+    RT,
+    RP,
+    Data,
+    Time,
+    Code,
+    Var,
+    Samp,
+    Kbd,
+    Sub,
+    Sup,
+    I,
+    B,
+    U,
+    Mark,
+    BDI,
+    BDO,
+    Span,
+    BR,
+    WBR,
+    Ins,
+    Del,
+    Picture,
+    Source,
+    Image,
+    IFrame,
+    Embed,
+    Object,
+    Video,
+    Audio,
+    Track,
+    Map,
+    Area,
+    Table,
+    Caption,
+    ColGroup,
+    Column,
+    TBody,
+    THead,
+    TFoot,
+    TR,
+    TD,
+    TH,
+    Form,
+    Label,
+    Input,
+    Button,
+    Select,
+    DataList,
+    OptGroup,
+    Option,
+    Progress,
+    Meter,
+    FieldSet,
+    Legend,
+    Details,
+    Summary,
+    Dialog,
+    Script,
+    NoScript,
+    Template,
+    Slot,
+    Canvas,
+)
+

ophinode/__main__.py

@@ -0,0 +1,94 @@
+import argparse
+
+EXAMPLE1 = """# Example program: render a page without defining a site.
+#
+# Running this program prints a HTML document to standard output.
+#
+from ophinode import *
+
+class MainPage:
+    def body(self):
+        return Div(
+            H1("Main Page"),
+            P("Welcome to ophinode!")
+        )
+
+    def head(self):
+        return [
+            Meta(charset="utf-8"),
+            Title("Main Page")
+        ]
+
+print(render_page(MainPage(), HTML5Layout()))
+"""
+
+EXAMPLE2 = """# Example program: create a page in a directory.
+#
+# Running this program creates "index.html" in "./out" directory.
+#
+from ophinode import *
+
+class DefaultLayout(Layout):
+    def build(self, page, context):
+        return [
+            HTML5Doctype(),
+            Html(
+                Head(
+                    Meta(charset="utf-8"),
+                    Title(page.title()),
+                    page.head()
+                ),
+                Body(
+                    page.body()
+                ),
+            )
+        ]
+
+class MainPage:
+    @property
+    def layout(self):
+        return DefaultLayout()
+
+    def body(self):
+        return Div(
+            H1("Main Page"),
+            P("Welcome to ophinode!")
+        )
+
+    def head(self):
+        return []
+
+    def title(self):
+        return "Main Page"
+
+if __name__ == "__main__":
+    site = Site({
+        "default_layout": DefaultLayout(),
+        "export_root_path": "./out",
+        "default_page_output_filename": "index.html",
+    }, [
+        ("/", MainPage()),
+    ])
+
+    site.build_site()
+"""
+
+def main():
+    parser = argparse.ArgumentParser(prog="ophinode")
+    parser.add_argument("subcommand", choices=["examples"])
+    parser.add_argument("arguments", nargs="*")
+    args = parser.parse_args()
+    if args.subcommand == "examples":
+        if not args.arguments:
+            print("available examples: render_page, basic_site")
+        elif args.arguments[0] == "render_page":
+            print(EXAMPLE1)
+        elif args.arguments[0] == "basic_site":
+            print(EXAMPLE2)
+        else:
+            print("available examples: render_page, basic_site")
+    else:
+        parser.print_help()
+
+if __name__ == "__main__":
+    main()

ophinode/constants.py

@@ -0,0 +1,13 @@
+"Collection of various constants."
+
+# Site options
+EXPORT_ROOT_PATH_OPTION_KEY = "export_root_path"
+EXPORT_ROOT_PATH_OPTION_DEFAULT_VALUE = ""
+DEFAULT_LAYOUT_OPTION_KEY = "default_layout"
+DEFAULT_LAYOUT_OPTION_DEFAULT_VALUE = None
+DEFAULT_PAGE_OUTPUT_FILENAME_OPTION_KEY = "default_page_output_filename"
+DEFAULT_PAGE_OUTPUT_FILENAME_OPTION_DEFAULT_VALUE = "index.html"
+PAGE_OUTPUT_FILE_EXTENSION_OPTION_KEY = "page_output_file_extension"
+PAGE_OUTPUT_FILE_EXTENSION_OPTION_DEFAULT_VALUE = "html"
+AUTO_EXPORT_FILES_OPTION_KEY = "auto_export_files"
+AUTO_EXPORT_FILES_OPTION_DEFAULT_VALUE = True

ophinode/exceptions.py

@@ -0,0 +1,17 @@
+class InvalidConfigurationError(Exception):
+    pass
+
+class RootPathUndefinedError(InvalidConfigurationError):
+    pass
+
+class RootPathIsNotADirectoryError(InvalidConfigurationError):
+    pass
+
+class NonRenderableNodeError(Exception):
+    pass
+
+class ExportPathCollisionError(Exception):
+    pass
+
+class InvalidAttributeNameError(Exception):
+    pass

ophinode/nodes/base.py

@@ -0,0 +1,45 @@
+from typing import Any
+from abc import ABC, abstractmethod
+
+class ClosedRenderable(ABC):
+    @abstractmethod
+    def render(self, context: "ophinode.rendering.RenderContext"):
+        pass
+
+class OpenRenderable(ABC):
+    @abstractmethod
+    def render_start(self, context: "ophinode.rendering.RenderContext"):
+        pass
+
+    @abstractmethod
+    def render_end(self, context: "ophinode.rendering.RenderContext"):
+        pass
+
+    @property
+    def auto_newline(self):
+        return False
+
+    @property
+    def auto_indent(self):
+        return False
+
+class Expandable(ABC):
+    @abstractmethod
+    def expand(self, context: "ophinode.rendering.RenderContext"):
+        pass
+
+class Preparable(ABC):
+    @abstractmethod
+    def prepare(self, context: "ophinode.rendering.RenderContext"):
+        pass
+
+class Page:
+    @property
+    def layout(self):
+        return None
+
+class Layout(ABC):
+    @abstractmethod
+    def build(self, page: Any, context: "ophinode.rendering.RenderContext"):
+        pass
+