Skip to content

App

App class to create a vivid app

Arguments

pages: Path | str Path to pages directory server: Path | str Path to server directory static: Path | str Path to static directory scripts: Path | str Path to scripts directory styles: Path | str Path to styles directory type: typing.Literal["ssr"] | typing.Literal["ssg"] Type of the app

Attributes:

Name Type Description
pages Path

Path to pages directory
server Path

Path to server directory
static Path

Path to static directory
scripts Path

Path to scripts directory
styles Path

Path to styles directory
type Literal['ssr'] | Literal['ssg']

Type of the app
http SSR | SSG | None

HTTP instance of the app
Source code in vivid/app.py 
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
class App:
    """
    App class to create a vivid app

    Arguments
    ---------
    pages: Path | str
        Path to pages directory
    server: Path | str
        Path to server directory
    static: Path | str
        Path to static directory
    scripts: Path | str
        Path to scripts directory
    styles: Path | str
        Path to styles directory
    type: typing.Literal["ssr"] | typing.Literal["ssg"]
        Type of the app

    Attributes
    ----------
    pages: Path
        Path to pages directory
    server: Path
        Path to server directory
    static: Path
        Path to static directory
    scripts: Path
        Path to scripts directory
    styles: Path
        Path to styles directory
    type: typing.Literal["ssr"] | typing.Literal["ssg"]
        Type of the app
    http: SSR | SSG | None
        HTTP instance of the app
    """

    def __init__(
        self,
        pages: Path | str,
        server: Path | str,
        static: Path | str,
        scripts: Path | str,
        styles: Path | str,
        type: t.Literal["ssr"] | t.Literal["ssg"] = "ssr",
    ) -> None:
        self.pages = Path(pages) if isinstance(pages, str) else pages
        self.server = Path(server) if isinstance(server, str) else server
        self.static = Path(static) if isinstance(static, str) else static
        self.scripts = Path(scripts) if isinstance(scripts, str) else scripts
        self.styles = Path(styles) if isinstance(styles, str) else styles
        self.type = type
        self.http: SSR | SSG | None = None

    def init(self) -> None:
        """
        Initialize the app by creating an SSR instance or an SSG instance

        Arguments
        ---------
        None

        Returns
        -------
        None
        """
        if self.type == "ssr":
            pages = {}
            for page in self.pages.rglob("*.html"):
                if "index.html" in str(page.name):
                    pages["/"] = page
                else:
                    pages["/" + str(page.relative_to(self.pages).as_posix()).replace(".html", "")] = page
            server = {}
            for file in self.server.rglob("*.py"):
                if "index.py" in str(file.name):
                    server["/"] = file
                else:
                    server["/" + str(file.relative_to(self.server).as_posix()).replace(".py", "")] = file
            static = {}
            for file in self.static.rglob("*"):
                if file.is_file():
                    static["/" + str(file.relative_to(self.static).as_posix())] = file
            scripts = {}
            for file in self.scripts.rglob("*.js"):
                if file.is_file():
                    scripts["/" + str(file.relative_to(self.scripts).as_posix())] = file
            styles = {}
            for file in self.styles.rglob("*.css"):
                if file.is_file():
                    styles["/" + str(file.relative_to(self.styles).as_posix())] = file
            self.http = SSR(
                pages=pages,
                server=server,
                static=static,
                scripts=scripts,
                styles=styles,
            )
        elif self.type == "ssg":
            pages = {}
            for page in self.pages.rglob("*.html"):
                if "index.html" in str(page.name):
                    pages["/"] = page
                else:
                    pages["/" + str(page.relative_to(self.pages).as_posix()).replace(".html", "")] = page
            server = {}
            for file in self.server.rglob("*.py"):
                if "index.py" in str(file.name):
                    server["/"] = file
                else:
                    server["/" + str(file.relative_to(self.server).as_posix()).replace(".py", "")] = file
            self.http = SSG(
                pages=pages,
                static=self.static,
                scripts=self.scripts,
                styles=self.styles,
                server=server,
            )

    def run(
        self,
        host: str = "localhost",
        port: int = 8000,
        dev: bool = False,
        reload_dirs: list[Path] = [],
    ) -> None:
        """
        Run the app if it is an SSR instance

        Arguments
        ---------
        host: str
            Host of the server
        port: int
            Port of the server
        dev: bool
            Whether to run in development mode
        reload_dirs: list[Path]
            Directories to reload on change

        Returns
        -------
        None
        """
        if self.type == "ssr" and isinstance(self.http, SSR):
            asyncio.get_event_loop().run_until_complete(
                self.http.run(host=host, port=port, dev=dev, reload_dirs=reload_dirs)
            )
        else:
            print("[#F43F5E bold]❌ Run method is only available for SSR instances[/#F43F5E bold]")
            exit(0)

    def build(self, dest: Path) -> None:
        """
        Build the app if it is an SSG instance

        Arguments
        ---------
        dest: Path
            Destination to build the app

        Returns
        -------
        None
        """
        if self.type == "ssg" and isinstance(self.http, SSG):
            asyncio.get_event_loop().run_until_complete(self.http.build(dest=dest))
        else:
            print("[#F43F5E bold]❌ Run method is only available for SSG instances[/#F43F5E bold]")
            exit(0)

build(dest)

Build the app if it is an SSG instance

Arguments

dest: Path Destination to build the app

Returns:

Type Description
None
Source code in vivid/app.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
def build(self, dest: Path) -> None:
    """
    Build the app if it is an SSG instance

    Arguments
    ---------
    dest: Path
        Destination to build the app

    Returns
    -------
    None
    """
    if self.type == "ssg" and isinstance(self.http, SSG):
        asyncio.get_event_loop().run_until_complete(self.http.build(dest=dest))
    else:
        print("[#F43F5E bold]❌ Run method is only available for SSG instances[/#F43F5E bold]")
        exit(0)

init()

Initialize the app by creating an SSR instance or an SSG instance

Arguments

None

Returns:

Type Description
None
Source code in vivid/app.py 
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def init(self) -> None:
    """
    Initialize the app by creating an SSR instance or an SSG instance

    Arguments
    ---------
    None

    Returns
    -------
    None
    """
    if self.type == "ssr":
        pages = {}
        for page in self.pages.rglob("*.html"):
            if "index.html" in str(page.name):
                pages["/"] = page
            else:
                pages["/" + str(page.relative_to(self.pages).as_posix()).replace(".html", "")] = page
        server = {}
        for file in self.server.rglob("*.py"):
            if "index.py" in str(file.name):
                server["/"] = file
            else:
                server["/" + str(file.relative_to(self.server).as_posix()).replace(".py", "")] = file
        static = {}
        for file in self.static.rglob("*"):
            if file.is_file():
                static["/" + str(file.relative_to(self.static).as_posix())] = file
        scripts = {}
        for file in self.scripts.rglob("*.js"):
            if file.is_file():
                scripts["/" + str(file.relative_to(self.scripts).as_posix())] = file
        styles = {}
        for file in self.styles.rglob("*.css"):
            if file.is_file():
                styles["/" + str(file.relative_to(self.styles).as_posix())] = file
        self.http = SSR(
            pages=pages,
            server=server,
            static=static,
            scripts=scripts,
            styles=styles,
        )
    elif self.type == "ssg":
        pages = {}
        for page in self.pages.rglob("*.html"):
            if "index.html" in str(page.name):
                pages["/"] = page
            else:
                pages["/" + str(page.relative_to(self.pages).as_posix()).replace(".html", "")] = page
        server = {}
        for file in self.server.rglob("*.py"):
            if "index.py" in str(file.name):
                server["/"] = file
            else:
                server["/" + str(file.relative_to(self.server).as_posix()).replace(".py", "")] = file
        self.http = SSG(
            pages=pages,
            static=self.static,
            scripts=self.scripts,
            styles=self.styles,
            server=server,
        )

run(host='localhost', port=8000, dev=False, reload_dirs=[])

Run the app if it is an SSR instance

Arguments

host: str Host of the server port: int Port of the server dev: bool Whether to run in development mode reload_dirs: list[Path] Directories to reload on change

Returns:

Type Description
None
Source code in vivid/app.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
def run(
    self,
    host: str = "localhost",
    port: int = 8000,
    dev: bool = False,
    reload_dirs: list[Path] = [],
) -> None:
    """
    Run the app if it is an SSR instance

    Arguments
    ---------
    host: str
        Host of the server
    port: int
        Port of the server
    dev: bool
        Whether to run in development mode
    reload_dirs: list[Path]
        Directories to reload on change

    Returns
    -------
    None
    """
    if self.type == "ssr" and isinstance(self.http, SSR):
        asyncio.get_event_loop().run_until_complete(
            self.http.run(host=host, port=port, dev=dev, reload_dirs=reload_dirs)
        )
    else:
        print("[#F43F5E bold]❌ Run method is only available for SSR instances[/#F43F5E bold]")
        exit(0)