You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-14Lines changed: 21 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,9 @@ This is a Python client for interfacing with the wonderful [Spendee app](https:/
4
4
5
5
The codebase was forked from [dionysio/spendee](https://github.com/dionysio/spendee) (many thanks! <3) in 2025, which was authored in 2019-2020 and archived since then.
6
6
7
+
About Spendee:
8
+
> Spendee.com is a budget and expense tracker application to manage personal finances. It allows users to connect bank accounts, e-wallets, and crypto wallets to get an aggregated overview of their financial situation. The app helps users organize and analyze spending through automatic transaction categorization, visually appealing graphs, and insights.
9
+
7
10
## ⚠️ Warning
8
11
9
12
This is a work in progress and is not recommended for general use yet. The original Spendee API is undocumented, and while this client works at the time of writing, it might stop working at any time. The author is not associated with Spendee in any way.
@@ -12,16 +15,29 @@ This is a work in progress and is not recommended for general use yet. The origi
12
15
13
16
## For Users
14
17
15
-
*This section is for people who want to use the `spendee-python-client` library in their own projects.*
18
+
To set up a development environment (only linux is documented):
16
19
17
-
_(Coming soon)_
20
+
1. Ensure you have Python 3.11+ installed.
21
+
2. Setup the virtual environment:
22
+
```bash
23
+
# Create a virtual environment
24
+
python3 -m venv .venv
25
+
# Activate the virtual environment
26
+
source .venv/bin/activate
27
+
# Install dependencies
28
+
pip install -r requirements.txt
29
+
```
30
+
3. Set credentials in a newly created `.env` file.
31
+
```bash
32
+
echo'EMAIL=<email>'> .env
33
+
echo'PASSWORD=<password'>> .env
34
+
```
35
+
4. Adapt `run.py`for your experiment and execute.
18
36
19
37
---
20
38
21
39
## For Developers & Contributors
22
40
23
-
*This section is for people who want to contribute to the development of this library.*
24
-
25
41
### Development Environment Setup
26
42
27
43
This project uses [mise](https://mise.jdx.dev/) to manage the development environment.
@@ -32,16 +48,7 @@ This project uses [mise](https://mise.jdx.dev/) to manage the development enviro
32
48
33
49
3. **Install Tools**: Once `mise` is activated, navigate to the project's root directory and run `mise install` to install the required tools.
34
50
35
-
4.**Set Credentials**: Create a `.env` file in the project root and add your Spendee credentials:
36
-
```bash
37
-
echo'EMAIL=<your-email>'> .env
38
-
echo'PASSWORD=<your-password>'>> .env
39
-
```
40
-
41
-
5. **Run**: You can now run the `run.py` script to experiment with the library:
0 commit comments