MoneyMate 1.1.3

Description of the project here

Python project template

A simple template of a Python project, with a rigid file structure, and predisposition for unit testing and release on PyPi.

Relevant features

• All your project code into a single main package (MoneyMate/)
• All your project tests into a single test package (test/)
• Unit testing support via unittest
• Automatic testing on all branches via GitHub Actions
• Semi-automatic versioning via Git
• Packaging support via setuptools
• Automatic release on PyPi via GitHub Actions
• Docker image support via Dockerfile
• Automatic release on DockerHub via GitHub Actions
• Support for semi-automatic development environment management via Pyenv
• Automatic dependencies updates via Renovate
• Automatic conversion of TODO comments into GitHub issues via the alstr/todo-to-issue-action

Project structure

.
├── src/
│   └── moneymate/
│       ├── __init__.py
│       ├── __main__.py
│       ├── cli.py
│       ├── data/
│       │   ├── __init__.py
│       │   └── database.py
│       ├── models/
│       ├── services/
│       ├── config/
│       └── utils/
├── MoneyMate/
│   ├── __init__.py
│   └── __main__.py
├── tests/
│   ├── unit/
│   │   └── test_data_layer.py
│   ├── integration/
│   └── conftest.py
├── sql/
├── scripts/
├── pyproject.toml
├── README.md
├── LICENSE
├── CHANGELOG.md
├── .github/
│   └── workflows/
│       ├── ci.yml
│       └── release.yml
├── renovate.json
└── .gitignore

artifact/ ├─ MoneyMate/ │ ├─ init.py │ ├─ data_layer/ │ │ ├─ init.py │ │ ├─ database.py # Low-level DB connection, schema, migration baseline │ │ ├─ manager.py # Process-wide API manager, orchestrates sub-managers │ │ ├─ users.py # Registration, login/logout, roles, password mgmt │ │ ├─ categories.py # CRUD for categories, ownership checks │ │ ├─ contacts.py # CRUD for contacts │ │ ├─ expenses.py # CRUD, search, deterministic listing, pagination │ │ ├─ transactions.py # CRUD, deterministic listing, pagination │ │ ├─ balances.py # Net balance and per-contact summaries │ │ ├─ logging_utils.py # Structured logging helpers │ │ └─ utils.py # Shared utilities, validators │ │ │ └─ gui/
│ ├─ init.py │ ├─ app.py # GUI entry-point │ └─ ... # Views, controllers, assets │ ├─ tests/ # test subdivided by category │ ├─ data_layer/ │ ├─ gui/
│ ├─ system/ │
├─ .github/ │ └─ workflows/ │
├─ LICENSE ├─ README.md ├─ pyproject.toml
├─ requirements.txt └─ requirements-dev.txt # Includes pytest (per CI notes)

## Flow Chart (architecture)

```mermaid
flowchart LR
  subgraph App["Application / GUI"]
    GUI["GUI Components"]
    CLI["Scripts / Integrations"]
  end

  subgraph API["API Manager"]
    MGR["DatabaseManager"]
  end

  subgraph Managers["Entity Managers"]
    U["Users"]
    C["Categories"]
    CO["Contacts"]
    E["Expenses"]
    T["Transactions"]
    B["Balances/Analytics"]
  end

  subgraph DB["SQLite Database"]
    SCHEMA["Versioned Schema + Migrations"]
    TABLES["Tables: users, categories, contacts, expenses, transactions, access_logs, ..."]
    INDEXES["Indexes + Constraints"]
  end

  App -->|calls| MGR
  MGR --> U & C & CO & E & T & B
  U & C & CO & E & T & B -->|validated SQL ops| DB
  DB -->|sqlite3.Row| MGR
  U -->|audit| TABLES
  MGR -->|logging| LOGS["Structured Logging"]

Acknowledgements

• Maintainers and contributors:
  • Andrea Giovanardi
  • Cristian Romeo
  • Matteo Fabbri

License

MIT License. See LICENSE.