Skip to content

cli#

make_splitlunch(**kwargs) #

Split all SplitLunch tagged transactions in half.

One of these new splits will be recategorized to Reimbursement.

Source code in lunchable_splitlunch/cli.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
@splitlunch.command("splitlunch")
@tag_transactions
def make_splitlunch(**kwargs: Union[int, str, bool]) -> None:
    """
    Split all `SplitLunch` tagged transactions in half.

    One of these new splits will be recategorized to `Reimbursement`.
    """
    from lunchable_splitlunch.lunchmoney_splitwise import SplitLunch

    splitlunch = SplitLunch()
    results = splitlunch.make_splitlunch(**kwargs)  # type: ignore[arg-type]
    json_data = to_jsonable_python(results)
    print_json(data=json_data)

make_splitlunch_direct_import(**kwargs) #

Import SplitLunchDirectImport tagged transactions to Splitwise

Send a transaction to Splitwise and then split the original transaction in Lunch Money. One of these new splits will be recategorized to Reimbursement. Any tags will be reapplied.

Source code in lunchable_splitlunch/cli.py 
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
@splitlunch.command("splitlunch-direct-import")
@tag_transactions
@financial_partner_id
@financial_partner_email
@financial_partner_group_id
def make_splitlunch_direct_import(**kwargs: Union[int, str, bool]) -> None:
    """
    Import `SplitLunchDirectImport` tagged transactions to Splitwise

    Send a transaction to Splitwise and then split the original
    transaction in Lunch Money. One of these new splits will be
    recategorized to `Reimbursement`. Any tags will be reapplied.
    """
    from lunchable_splitlunch.lunchmoney_splitwise import SplitLunch

    financial_partner_id: Optional[int] = kwargs.pop("financial_partner_id")  # type: ignore[assignment]
    financial_partner_email: Optional[str] = kwargs.pop("financial_partner_email")  # type: ignore[assignment]
    financial_partner_group_id: Optional[int] = kwargs.pop("financial_partner_group_id")  # type: ignore[assignment]
    splitlunch = SplitLunch(
        financial_partner_id=financial_partner_id,
        financial_partner_email=financial_partner_email,
        financial_partner_group_id=financial_partner_group_id,
    )
    results = splitlunch.make_splitlunch_direct_import(**kwargs)  # type: ignore[arg-type]
    json_data = to_jsonable_python(results)
    print_json(data=json_data)

make_splitlunch_import(**kwargs) #

Import SplitLunchImport tagged transactions to Splitwise

Send a transaction to Splitwise and then split the original transaction in Lunch Money. One of these new splits will be re-categorized to Reimbursement. Any tags will be reapplied.

Source code in lunchable_splitlunch/cli.py 
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
@splitlunch.command("splitlunch-import")
@tag_transactions
@financial_partner_id
@financial_partner_email
@financial_partner_group_id
def make_splitlunch_import(**kwargs: Union[int, str, bool]) -> None:
    """
    Import `SplitLunchImport` tagged transactions to Splitwise

    Send a transaction to Splitwise and then split the original
    transaction in Lunch Money. One of these new splits will be
    re-categorized to `Reimbursement`. Any tags will be reapplied.
    """
    from lunchable_splitlunch.lunchmoney_splitwise import SplitLunch

    financial_partner_id: Optional[int] = kwargs.pop("financial_partner_id")  # type: ignore[assignment]
    financial_partner_email: Optional[str] = kwargs.pop("financial_partner_email")  # type: ignore[assignment]
    financial_partner_group_id: Optional[int] = kwargs.pop("financial_partner_group_id")  # type: ignore[assignment]
    splitlunch = SplitLunch(
        financial_partner_id=financial_partner_id,
        financial_partner_email=financial_partner_email,
        financial_partner_group_id=financial_partner_group_id,
    )
    results = splitlunch.make_splitlunch_import(**kwargs)  # type: ignore[arg-type]
    json_data = to_jsonable_python(results)
    print_json(data=json_data)

refresh_splitwise_transactions(dated_before, dated_after, allow_self_paid, allow_payments) #

Import New Splitwise Transactions to Lunch Money and

This function gets all transactions from Splitwise, all transactions from your Lunch Money Splitwise account and compares the two. This also updates the account balance.

Source code in lunchable_splitlunch/cli.py 
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
@splitlunch.command("refresh")
@dated_after
@dated_before
@click.option(
    "--allow-self-paid/--no-allow-self-paid",
    default=False,
    help="Allow self-paid expenses to be imported (filtered out by default).",
)
@click.option(
    "--allow-payments/--no-allow-payments",
    default=False,
    help="Allow payments to be imported (filtered out by default).",
)
def refresh_splitwise_transactions(
    dated_before: Optional[datetime.datetime],
    dated_after: Optional[datetime.datetime],
    allow_self_paid: bool,
    allow_payments: bool,
) -> None:
    """
    Import New Splitwise Transactions to Lunch Money and

    This function gets all transactions from Splitwise, all transactions from
    your Lunch Money Splitwise account and compares the two. This also updates
    the account balance.
    """
    from lunchable_splitlunch.lunchmoney_splitwise import SplitLunch

    splitlunch = SplitLunch()
    response = splitlunch.refresh_splitwise_transactions(
        dated_before=dated_before,
        dated_after=dated_after,
        allow_self_paid=allow_self_paid,
        allow_payments=allow_payments,
    )
    json_data = to_jsonable_python(response)
    print_json(data=json_data)

splitlunch() #

Splitwise Plugin for lunchable, SplitLunch 💲🍱

Source code in lunchable_splitlunch/cli.py 
12
13
14
15
16
17
@click.group
def splitlunch() -> None:
    """
    Splitwise Plugin for lunchable, SplitLunch 💲🍱
    """
    pass

splitlunch_expenses(**kwargs) #

Retrieve Splitwise Expenses

Source code in lunchable_splitlunch/cli.py 
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
@splitlunch.command("expenses")
@click.option(
    "--limit", default=None, help="Limit the amount of Results. 0 returns everything."
)
@click.option("--offset", default=None, help="Number of expenses to be skipped")
@click.option("--limit", default=None, help="Number of expenses to be returned")
@click.option("--group-id", default=None, help="GroupID of the expenses")
@click.option("--friendship-id", default=None, help="FriendshipID of the expenses")
@dated_after
@dated_before
@click.option(
    "--updated-after",
    default=None,
    help="ISO 8601 Date time. Return expenses updated after this date",
)
@click.option(
    "--updated-before",
    default=None,
    help="ISO 8601 Date time. Return expenses updated before this date",
)
def splitlunch_expenses(**kwargs: Union[int, str, bool]) -> None:
    """
    Retrieve Splitwise Expenses
    """
    from lunchable_splitlunch.lunchmoney_splitwise import SplitLunch

    splitlunch = SplitLunch()
    if set(kwargs.values()) == {None}:
        kwargs["limit"] = 5
    expenses = splitlunch.get_expenses(**kwargs)  # type: ignore[arg-type]
    json_data = to_jsonable_python(expenses)
    print_json(data=json_data)

update_splitwise_balance() #

Update the Splitwise Asset Balance

Source code in lunchable_splitlunch/cli.py 
162
163
164
165
166
167
168
169
170
171
172
@splitlunch.command("update-balance")
def update_splitwise_balance() -> None:
    """
    Update the Splitwise Asset Balance
    """
    from lunchable_splitlunch.lunchmoney_splitwise import SplitLunch

    splitlunch = SplitLunch()
    updated_asset = splitlunch.update_splitwise_balance()
    json_data = to_jsonable_python(updated_asset)
    print_json(data=json_data)