Budgetter-server

🧾 Budgetter is a personal finance management software such as Money.

Report Bug · Request Feature

---

🚀 Features

• OFX Import: Easily import transaction files from your bank.
• AI Categorization: Automatically categorizes transactions using a local AI model (DistilBART).
  • Privacy First: The AI runs entirely on your machine. No data leaves your server.
  • Zero-Shot: No training required. It understands categories like "Groceries" or "Transport" out of the box.
• Rule-Based Engine: Define custom rules for exact matches (highest priority).
• Dashboard: Visualize your spending with charts and graphs.

🛠️ Installation

1. Clone the repository

   git clone https://github.com/opierre/Budgetter.git
   cd Budgetter/budgetter_server

2. Install dependencies

   pip install .
   # Or for development (editable mode):
   # pip install -e .

   Note: This will install transformers and torch for the AI features (~2GB).

3. Apply migrations

   python manage.py makemigrations

   python manage.py migrate

🏃 Usage

1. Start the server

   python manage.py runserver

   On first launch, the AI model (~300MB) will be downloaded and cached automatically.

2. Access the app Open http://127.0.0.1:8000 in your browser.

🧪 Testing

Run the comprehensive test suite to verify functionality:

# Run tests
python manage.py test dashboard.tests_coverage

# Run with coverage report
coverage run --source='dashboard,utils' manage.py test dashboard.tests_coverage
coverage report