Skip to content

Config

Config

Class defining the configuration to run mtg_pynance with.

Parameters:

Name Type Description Default
workspace_path Path

Path to the workspace directory.

 required
collection_path Path

Path to the card collection csv file.

 required

Methods:

Name Description
create_workspace

Creates the workspace folder.
get_bulk_info_path

Returns the path of Scryfall's bulk data default cards information json file.
get_bulk_data_path

Returns the path of Scryfall's bulk data default cards json file.
get_database_path

Returns the path to the local SQL collection database.
get_bulk_data_timestamp

Get timestamp of local bulk data files.
Source code in src/mtg_pynance/config.py 
 7
 8
 9
10
11
12
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
class Config:
    """
    Class defining the configuration to run mtg_pynance with.

    Parameters
    ----------
    workspace_path: Path
        Path to the workspace directory.
    collection_path: Path
        Path to the card collection csv file.

    Methods
    -------
    create_workspace()
        Creates the workspace folder.
    get_bulk_info_path() -> Path
        Returns the path of Scryfall's bulk data default cards information
        json file.
    get_bulk_data_path() -> Path
        Returns the path of Scryfall's bulk data default cards json file.
    get_database_path() -> Path
        Returns the path to the local SQL collection database.
    get_bulk_data_timestamp() -> Optional[datetime.date]
        Get timestamp of local bulk data files.
    """

    def __init__(self, workspace_path: Path, collection_path: Path) -> None:
        self.workspace_path = workspace_path
        if not collection_path.exists():
            raise Exception("Collection file does not exist at input path!")
        self.collection_path = collection_path

    def create_workspace(self):
        """
        Creates the workspace folder.
        """
        if not self.workspace_path.exists():
            self.workspace_path.mkdir()

    def get_bulk_info_path(self) -> Path:
        """
        Returns the path to Scryfall's bulk data default cards information
        json file.
        """
        path = self.workspace_path / "bulk_default_info.json"
        return path

    def get_bulk_data_path(self) -> Path:
        """
        Returns the path to Scryfall's bulk data default cards json file.
        """
        path = self.workspace_path / "bulk_default_data.json"
        return path

    def get_database_path(self) -> Path:
        """
        Returns the path to the SQL collection database where each card in
        the collection has its information stored.
        """
        path = self.workspace_path / "collection.db"
        return path

    def get_bulk_data_timestamp(self) -> Optional[datetime.date]:
        """
        Get timestamp of local bulk data files if they exist or return
        None if they don't.
        """
        if (
            not self.get_bulk_info_path().exists()
            or not self.get_bulk_data_path().exists()
        ):
            return None

        # Get timestamp of local files
        with open(self.get_bulk_info_path()) as f:
            bulk_info_dict = json.load(f)
        local_ts = bulk_info_dict["updated_at"]
        local_dt = datetime.fromisoformat(local_ts)

        return local_dt

create_workspace()

Creates the workspace folder.

Source code in src/mtg_pynance/config.py 
39
40
41
42
43
44
def create_workspace(self):
    """
    Creates the workspace folder.
    """
    if not self.workspace_path.exists():
        self.workspace_path.mkdir()

get_bulk_data_path()

Returns the path to Scryfall's bulk data default cards json file.

Source code in src/mtg_pynance/config.py 
54
55
56
57
58
59
def get_bulk_data_path(self) -> Path:
    """
    Returns the path to Scryfall's bulk data default cards json file.
    """
    path = self.workspace_path / "bulk_default_data.json"
    return path

get_bulk_data_timestamp()

Get timestamp of local bulk data files if they exist or return None if they don't.

Source code in src/mtg_pynance/config.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def get_bulk_data_timestamp(self) -> Optional[datetime.date]:
    """
    Get timestamp of local bulk data files if they exist or return
    None if they don't.
    """
    if (
        not self.get_bulk_info_path().exists()
        or not self.get_bulk_data_path().exists()
    ):
        return None

    # Get timestamp of local files
    with open(self.get_bulk_info_path()) as f:
        bulk_info_dict = json.load(f)
    local_ts = bulk_info_dict["updated_at"]
    local_dt = datetime.fromisoformat(local_ts)

    return local_dt

get_bulk_info_path()

Returns the path to Scryfall's bulk data default cards information json file.

Source code in src/mtg_pynance/config.py 
46
47
48
49
50
51
52
def get_bulk_info_path(self) -> Path:
    """
    Returns the path to Scryfall's bulk data default cards information
    json file.
    """
    path = self.workspace_path / "bulk_default_info.json"
    return path

get_database_path()

Returns the path to the SQL collection database where each card in the collection has its information stored.

Source code in src/mtg_pynance/config.py 
61
62
63
64
65
66
67
def get_database_path(self) -> Path:
    """
    Returns the path to the SQL collection database where each card in
    the collection has its information stored.
    """
    path = self.workspace_path / "collection.db"
    return path