Skip to content

Commit a98cde4

Browse files
juftinjuftin
committed
🐛 remove plugins from lunchable
1 parent c561944 commit a98cde4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+335
-4275
lines changed

‎README.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
**lunchable** is a Python Client for the [Lunch Money Developer API](https://lunchmoney.dev). It's
2424
built on top of [pydantic](https://github.com/pydantic/pydantic) and [httpx](https://github.com/encode/httpx/),
2525
it offers an _intuitive_ API, a _simple_ CLI, complete coverage of all endpoints,
26-
and _plugins_ to other external services.
26+
and a _plugin_ framework for extending the functionality of the library.
2727

2828
### Installation
2929

@@ -46,10 +46,20 @@ first_transaction: TransactionObject = transactions[0]
4646
transaction_as_dict: Dict[str, Any] = first_transaction.model_dump()
4747
```
4848

49+
### CLI
50+
51+
To use the CLI, you'll need to set the `LUNCHMONEY_ACCESS_TOKEN` environment variable.
52+
It's recommended to use [pipx](https://github.com/pypa/pipx) to install the CLI -
53+
use the `lunchable[plugins]` extra to include all the known plugins:
54+
55+
```shell
56+
pipx install "lunchable[plugins]"
57+
```
58+
4959
```shell
5060
export LUNCHMONEY_ACCESS_TOKEN="xxxxxxxxxxx"
5161
lunchable transactions get --limit 5
52-
lunchable http -X GET https://dev.lunchmoney.app/v1/assets
62+
lunchable http -X GET v1/assets
5363
```
5464

5565
<!--skip-->

‎codecov.yaml‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/plugins/index.md renamed to docs/plugins.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
# Plugins
22

3-
To install all the known plugins, and their dependencies, install
3+
`lunchable` plugins are Python packages outside of the `lunchable` package that
4+
can be installed into the same environment as `lunchable` to add additional
5+
functionality to the CLI. To install all the known plugins, and their dependencies, install
46
lunchable with the `plugins` extra:
57

68
```shell
79
pipx install "lunchable[plugins]"
810
```
911

10-
lunchable supports CLI plugins with other external packages. See below for what's been built already.
11-
If you can't find what you're looking for, consider building it yourself and opening a pull-request
12-
to add it to the list below:
12+
lunchable supports CLI plugins with other external packages. See below for what's been built
13+
already. If you can't find what you're looking for, consider building it yourself and
14+
opening a pull-request to add it to the list:
1315

14-
- [PushLunch](pushlunch.md): Push Notifications via Pushover
15-
- [SplitLunch](splitlunch.md): Splitwise Integration
16-
- [PrimeLunch](primelunch.md): Amazon Transaction Updater
16+
- [PushLunch](https://github.com/juftin/lunchable-pushlunch): Push Notifications via Pushover
17+
- [SplitLunch](https://github.com/juftin/lunchable-splitlunch): Splitwise Integration
18+
- [PrimeLunch](https://github.com/juftin/lunchable-primelunch): Amazon Transaction Updater
1719

1820
## LunchableApp
1921

@@ -23,12 +25,12 @@ and more. Notice a few of the main attributes / methods of the `LunchableApp` cl
2325

2426
attribute / method | description | type
2527
------------------------------------------------------------------------------|--------------------------------------------------------------------------------|-------------------------------------------------------
26-
**`lunch`** | The `LunchMoney` client | [LunchMoney](../interacting.md#lunchmoney)
28+
**`lunch`** | The `LunchMoney` client | [LunchMoney](interacting.md#lunchmoney)
2729
**`data`** ¹ | The `LunchableData` object | [LunchableData](#lunchable.plugins.app.LunchableData)
2830
[refresh_data](#lunchable.plugins.LunchableApp.refresh_data) | Refresh all data (besides Transactions) | `method`
2931
[refresh_transactions](#lunchable.plugins.LunchableApp.refresh_transactions) | Refresh transactions, takes same parameters as `LunchMoney.get_transactions()` | `method`
3032
[refresh](#lunchable.plugins.LunchableApp.refresh) ² | Refresh the data for one particular model, takes **kwargs | `method`
31-
[clear_transactions](#lunchable.plugins.LunchableApp.clear_transactions) ³ | Clear all transactions from the internal data | `method`
33+
[clear_transactions](#lunchable.plugins.LunchableApp.clear_transactions) ³ | Clear all transactions from the internal data | `method`
3234

3335
> ¹ This attribute contains all of the data that is loaded from LunchMoney. It has attributes
3436
> for `assets`, `categories`, `plaid_accounts`, `tags`, `transactions`, `crypto` and `user`.
@@ -37,7 +39,7 @@ and more. Notice a few of the main attributes / methods of the `LunchableApp` cl
3739
3840
> ² This method refreshes all of the data for one particular model. For example,
3941
> `refresh(AssetsObject)` will refresh the assets on the underling `data.assets`
40-
> attribute and return a `dict[int, AssetsObject]` object.
42+
> attribute and return a `dict[int, AssetsObject]` object.
4143
4244
> ³ This the same as running `app.data.transactions.clear()`
4345

‎docs/plugins/primelunch.md‎

Lines changed: 0 additions & 109 deletions
This file was deleted.

‎docs/plugins/pushlunch.md‎

Lines changed: 0 additions & 51 deletions
This file was deleted.

‎docs/plugins/splitlunch.md‎

Lines changed: 0 additions & 114 deletions
This file was deleted.

‎lunchable/_config/api_config.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def get_access_token(access_token: Optional[str] = None) -> str:
5555
str
5656
"""
5757
if access_token is None:
58-
logger.info(
58+
logger.debug(
5959
"Loading Lunch Money Developer API Access token from environment"
6060
)
6161
access_token = getenv(APIConfig._access_token_environment_variable, None)

0 commit comments

Comments
 (0)