Skip to content

api_config#

API Configuration Helper

APIConfig #

Configuration Helper Class for Connecting to the Lunchmoney API

Source code in lunchable/_config/api_config.py 
 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
class APIConfig:
    """
    Configuration Helper Class for Connecting to the Lunchmoney API
    """

    LUNCHMONEY_SCHEME: str = "https"
    LUNCHMONEY_NETLOC: str = "dev.lunchmoney.app"
    LUNCHMONEY_API_PATH: str = "v1"

    LUNCHMONEY_TRANSACTIONS: str = "transactions"
    LUNCHMONEY_TRANSACTION_GROUPS: str = "group"
    LUNCHMONEY_PLAID_ACCOUNTS: str = "plaid_accounts"
    LUNCH_MONEY_RECURRING_EXPENSES: str = "recurring_expenses"
    LUNCH_MONEY_RECURRING_ITEMS: str = "recurring_items"
    LUNCHMONEY_BUDGET: str = "budgets"
    LUNCHMONEY_ASSETS: str = "assets"
    LUNCHMONEY_CATEGORIES: str = "categories"
    LUNCHMONEY_TAGS: str = "tags"
    LUNCHMONEY_CRYPTO: str = "crypto"
    LUNCHMONEY_CRYPTO_MANUAL: str = "manual"
    LUNCHMONEY_ME: str = "me"

    LUNCHMONEY_CONTENT_TYPE_HEADERS: Dict[str, str] = {
        "Content-Type": "application/json"
    }

    _access_token_environment_variable = "LUNCHMONEY_ACCESS_TOKEN"

    @staticmethod
    def get_access_token(access_token: Optional[str] = None) -> str:
        """
        Method for Resolving Access Tokens: Hardcoded -> .env File -> Env Var

        Parameters
        ----------
        access_token: Optional[str]
            Lunchmoney Developer API Access Token

        Returns
        -------
        str
        """
        if access_token is None:
            logger.debug(
                "Loading Lunch Money Developer API Access token from environment"
            )
            access_token = getenv(APIConfig._access_token_environment_variable, None)
        if access_token is None:
            access_token_error_message = (
                "You must provide a Lunch Money Developer API Access Token directly or set your "
                f"{APIConfig._access_token_environment_variable} environment variable."
            )
            raise EnvironmentVariableError(access_token_error_message)
        return access_token

    @staticmethod
    def get_header(access_token: Optional[str] = None) -> Dict[str, str]:
        """
        Get the header dict to pass to httpx

        Parameters
        ----------
        access_token: Optional[str]
            Lunchmoney Developer API Access Token

        Returns
        -------
        Dict[str, str]
        """
        access_token = APIConfig.get_access_token(access_token=access_token)
        lunchable_header = {
            "Authorization": f"Bearer {access_token}",
            "User-Agent": f"lunchable/{__version__}",
        }
        lunchable_header.update(APIConfig.LUNCHMONEY_CONTENT_TYPE_HEADERS)
        return lunchable_header

    @staticmethod
    def make_url(url_path: Union[List[Union[str, int]], str, int]) -> str:
        """
        Make a Lunch Money API URL using path parts

        Parameters
        ----------
        url_path: Union[List[Union[str, int]], str, int]
            API Components, if a list join these sequentially

        Returns
        -------
        str
        """
        if isinstance(url_path, str):
            url_path = [url_path]
        if not isinstance(url_path, List):
            raise LunchMoneyError(
                "You must provide a string or list of strings to construct a URL"
            )
        path_set = [
            str(item).lower()
            for item in url_path
            if str(item).lower() != APIConfig.LUNCHMONEY_API_PATH
        ]
        url = APIConfig._generate_url(
            scheme=APIConfig.LUNCHMONEY_SCHEME,
            netloc=APIConfig.LUNCHMONEY_NETLOC,
            path="/".join([APIConfig.LUNCHMONEY_API_PATH, *path_set]),
        )
        return url

    @classmethod
    def _generate_url(
        cls,
        scheme: str,
        netloc: str,
        path: str = "",
        params: str = "",
        query: str = "",
        fragment: str = "",
    ) -> str:
        """
        Build a URL

        Parameters
        ----------
        scheme: str
            URL scheme specifier
        netloc: str
            Network location part
        path: str
            Hierarchical path
        params: str
            Parameters for last path element
        query: str
            Query component
        fragment: str
            Fragment identifier
        Returns
        -------
        url: str
            Compiled URL
        """
        url_components = {
            "scheme": scheme,
            "netloc": netloc,
            "path": path,
            "params": params,
            "query": query,
            "fragment": fragment,
        }
        return parse.urlunparse(components=tuple(url_components.values()))

get_access_token(access_token=None) staticmethod #

Method for Resolving Access Tokens: Hardcoded -> .env File -> Env Var

Parameters:

Name Type Description Default
access_token Optional[str]

Lunchmoney Developer API Access Token

 None

Returns:

Type Description
str
Source code in lunchable/_config/api_config.py 
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
@staticmethod
def get_access_token(access_token: Optional[str] = None) -> str:
    """
    Method for Resolving Access Tokens: Hardcoded -> .env File -> Env Var

    Parameters
    ----------
    access_token: Optional[str]
        Lunchmoney Developer API Access Token

    Returns
    -------
    str
    """
    if access_token is None:
        logger.debug(
            "Loading Lunch Money Developer API Access token from environment"
        )
        access_token = getenv(APIConfig._access_token_environment_variable, None)
    if access_token is None:
        access_token_error_message = (
            "You must provide a Lunch Money Developer API Access Token directly or set your "
            f"{APIConfig._access_token_environment_variable} environment variable."
        )
        raise EnvironmentVariableError(access_token_error_message)
    return access_token

get_header(access_token=None) staticmethod #

Get the header dict to pass to httpx

Parameters:

Name Type Description Default
access_token Optional[str]

Lunchmoney Developer API Access Token

 None

Returns:

Type Description
Dict[str, str]
Source code in lunchable/_config/api_config.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
@staticmethod
def get_header(access_token: Optional[str] = None) -> Dict[str, str]:
    """
    Get the header dict to pass to httpx

    Parameters
    ----------
    access_token: Optional[str]
        Lunchmoney Developer API Access Token

    Returns
    -------
    Dict[str, str]
    """
    access_token = APIConfig.get_access_token(access_token=access_token)
    lunchable_header = {
        "Authorization": f"Bearer {access_token}",
        "User-Agent": f"lunchable/{__version__}",
    }
    lunchable_header.update(APIConfig.LUNCHMONEY_CONTENT_TYPE_HEADERS)
    return lunchable_header

make_url(url_path) staticmethod #

Make a Lunch Money API URL using path parts

Parameters:

Name Type Description Default
url_path Union[List[Union[str, int]], str, int]

API Components, if a list join these sequentially

 required

Returns:

Type Description
str
Source code in lunchable/_config/api_config.py 
 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
@staticmethod
def make_url(url_path: Union[List[Union[str, int]], str, int]) -> str:
    """
    Make a Lunch Money API URL using path parts

    Parameters
    ----------
    url_path: Union[List[Union[str, int]], str, int]
        API Components, if a list join these sequentially

    Returns
    -------
    str
    """
    if isinstance(url_path, str):
        url_path = [url_path]
    if not isinstance(url_path, List):
        raise LunchMoneyError(
            "You must provide a string or list of strings to construct a URL"
        )
    path_set = [
        str(item).lower()
        for item in url_path
        if str(item).lower() != APIConfig.LUNCHMONEY_API_PATH
    ]
    url = APIConfig._generate_url(
        scheme=APIConfig.LUNCHMONEY_SCHEME,
        netloc=APIConfig.LUNCHMONEY_NETLOC,
        path="/".join([APIConfig.LUNCHMONEY_API_PATH, *path_set]),
    )
    return url