buildStore.py

import csv
import json
import os
from dataclasses import dataclass
from pathlib import Path

OUTPUT_DIR = "release"
OUTPUT_FILE = "sudoFrameworks.json"
INPUT_FILE = "data/quillFrameworks.csv"
VERSION = "v.0.1.0"


@dataclass
class FrameworkVersion:
    id: str
    release_date: str
    stable: bool

    def to_dict(self) -> dict:
        info = {
            "id": self.id,
            "release_date": self.release_date,
            "stable": self.stable,
        }
        return info


@dataclass
class FramworkEntry:
    name: str
    publisher: str
    url: str
    version: FrameworkVersion

    def to_dict(self) -> dict:
        info = {
            "name": self.name,
            "publisher": self.publisher,
            "url": self.url,
            "version": self.version.to_dict(),
        }

        return info

    @staticmethod
    def from_row(info: list):
        return FramworkEntry(
            name=info[0],
            publisher=info[1],
            url=info[2],
            version=FrameworkVersion(
                id=info[3],
                release_date=info[4],
                stable=True if info[5] == "true" else False,
            ),
        )


def read_file() -> list[FramworkEntry]:
    entries = []
    with open(
        INPUT_FILE,
        "r",
        newline="",
    ) as csvFile:
        frameworkReader = csv.reader(csvFile, delimiter=",")
        # skip header row
        next(frameworkReader)
        for eachRow in frameworkReader:
            entry = FramworkEntry.from_row(eachRow)
            entries.append(entry)
    print("list of farmeworks generated")
    return entries


def output_file(entries: list[FramworkEntry]):
    # ensure our output path exists
    path = Path(OUTPUT_DIR)
    if path.is_dir():
        pass
    else:
        # create path if it does not yet exist
        os.mkdir(OUTPUT_DIR)

    frameworks = []

    for each in entries:
        frameworks.append(each.to_dict())

    output_json = {
        "version": VERSION,
        "frameworks": frameworks,
    }

    # output file to disk
    output_file = path / OUTPUT_FILE
    print(f"writing {output_file} to disk")
    with open(output_file, "w") as json_file:
        json.dump(output_json, json_file)


def main() -> None:
    print(f"reading {INPUT_FILE}")
    entries = read_file()
    print("outputting file to disk")
    output_file(entries)


if __name__ == "__main__":
    main()