Skip to content

fixes #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shaygol merged 1 commit into from
Jan 31, 2026
Merged

fixes #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,8 @@ jobs:
"@
Set-Content -Path "deployment\README.txt" -Value $readmeContent

- name: Zip Deployment Package
run: |
Compress-Archive -Path deployment\* -DestinationPath BudgetTracker-Deployment.zip

- name: Upload Deployment Artifact
uses: actions/upload-artifact@v4
with:
name: BudgetTracker-Deployment
path: BudgetTracker-Deployment.zip
path: deployment/
3 changes: 1 addition & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@
/UserFiles/**
/output/**
/deployment/**
/venv/
/.venv/
*venv/

29 changes: 27 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,24 @@ It supports Hebrew-language inputs and outputs a categorized summary into a pre-

The application organizes your data in the `UserFiles` directory:
- `UserFiles/dashboard.xlsx`: Your main dashboard file.
- `UserFiles/categories.json`: Your saved category mappings.
- `UserFiles/categories.json`: Your personal category mappings (overrides defaults).
- `UserFiles/backups/`: Automatic backups of dashboard, archives and temporary location for processing files.
- `src/default_categories.json`: Pre-configured merchant categories (read-only, included with the app).

### Category System

The Budget Tracker uses a two-tier category system:

1. **Default Categories** (`src/default_categories.json`):
- 200+ pre-configured Israeli merchants (supermarkets, gas stations, restaurants, etc.)
- Maintained by the application and updated with new versions
- Read-only - always loaded as the baseline

2. **User Categories** (`UserFiles/categories.json`):
- Your personal mappings that override defaults
- New merchants you add are saved here
- You can override default mappings by confirming them through the GUI
- Empty by default - grows as you use the app

## Usage

Expand Down Expand Up @@ -149,7 +165,16 @@ _Note: This diagram reflects the up-to-date workflow, including mapping, dashboa
**Important**: Never delete the Template sheet or rename it unless you also update the configuration in `src/config.py`.

====================================================================================
## Recent Changes [v2.0] - 2026-01-30
## Recent Changes [v2.1] - 2026-01-31

- **Category System Refactoring**
- Separated default categories from user categories
- 200+ pre-configured Israeli merchants in `src/default_categories.json`
- User mappings now only save overrides in `UserFiles/categories.json`
- Cleaner data separation - defaults come with updates, user data stays intact

====================================================================================
## Previous Changes [v2.0] - 2026-01-30

- **Daily Use Improvements**
- Delete files with confirmation dialog
Expand Down
Loading