Skip to content

API Key

GoogleApiKey

This class provides methods to get and set the Google AI platform API key.

Source code in peter_explains/api_key.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
class GoogleApiKey:
    """
    This class provides methods to get and set the Google AI platform API key.
    """

    def __init__(self) -> None:
        self.api_key_path = GoogleApiKey.get_api_ley_file_path()

    @staticmethod
    def get_api_ley_file_path() -> str:
        if os.name == "nt":
            api_file_path = os.path.join(
                os.getenv("LOCALAPPDATA"), __app_name__, f"{__app_name__}_api.json"
            )
        elif os.name == "posix":
            home = os.path.expanduser("~")
            if sys.platform == "darwin":
                api_file_path = os.path.join(
                    home,
                    "Library",
                    "Application Support",
                    __app_name__,
                    f"{__app_name__}_api.json",
                )
            else:
                api_file_path = os.path.join(
                    home, ".config", __app_name__, f"{__app_name__}_api.json"
                )

        return api_file_path

    def get(self) -> str:
        """
        Retrieves the API key from the specified file.

        Returns:
            str: The API key.

        Raises:
            FileNotFoundError: If the API key file does not exist.
        """
        if not os.path.exists(self.api_key_path):
            show_no_api_key_error()
            sys.exit(1)

        with open(self.api_key_path, "r", encoding="utf-8") as file:
            data = json.load(file)
            return data["api_key"]

    def set(self, api_key: str):
        """
        Sets the API key for the application.

        Args:
            api_key (str): The API key to be set.

        Raises:
            ValueError: If the length of the API key is less than 30 or greater than 50.

        Returns:
            None
        """
        if len(api_key) < 30 or len(api_key) > 50:
            show_crappy_api_key_error()
            sys.exit(1)

        with open(self.api_key_path, "w", encoding="utf-8") as file:
            json.dump({"api_key": api_key}, file)
        show_api_key_success_message()
        sys.exit(0)

    def clear(self):
        """
        This function clears the API key from the keyring.

        Args:
            None

        Returns:
            None
        """
        os.remove(self.api_key_path)
        print("Retep just deleted your API key. Loser!")

clear()

This function clears the API key from the keyring.

Returns:

Type Description

None
Source code in peter_explains/api_key.py 
84
85
86
87
88
89
90
91
92
93
94
95
def clear(self):
    """
    This function clears the API key from the keyring.

    Args:
        None

    Returns:
        None
    """
    os.remove(self.api_key_path)
    print("Retep just deleted your API key. Loser!")

get()

Retrieves the API key from the specified file.

Returns:

Name Type Description
str str

The API key.

Raises:

Type Description
FileNotFoundError

If the API key file does not exist.
Source code in peter_explains/api_key.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def get(self) -> str:
    """
    Retrieves the API key from the specified file.

    Returns:
        str: The API key.

    Raises:
        FileNotFoundError: If the API key file does not exist.
    """
    if not os.path.exists(self.api_key_path):
        show_no_api_key_error()
        sys.exit(1)

    with open(self.api_key_path, "r", encoding="utf-8") as file:
        data = json.load(file)
        return data["api_key"]

set(api_key)

Sets the API key for the application.

Parameters:

Name Type Description Default
api_key str

The API key to be set.

 required

Raises:

Type Description
ValueError

If the length of the API key is less than 30 or greater than 50.

Returns:

Type Description

None
Source code in peter_explains/api_key.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def set(self, api_key: str):
    """
    Sets the API key for the application.

    Args:
        api_key (str): The API key to be set.

    Raises:
        ValueError: If the length of the API key is less than 30 or greater than 50.

    Returns:
        None
    """
    if len(api_key) < 30 or len(api_key) > 50:
        show_crappy_api_key_error()
        sys.exit(1)

    with open(self.api_key_path, "w", encoding="utf-8") as file:
        json.dump({"api_key": api_key}, file)
    show_api_key_success_message()
    sys.exit(0)