mmex_lib 0.1.2-beta.1

Library for interacting with Money Manager EX data and logic
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

# MMEX Lib

Rust library for interacting with Money Manager EX (MMEX) data and logic, with UniFFI support for multi-language bindings.

> ⚠️ **PROJECT STATUS: BETA**
> This library is in beta phase. API changes may occur. Use with caution.

---

### 🌐 Documentación en Español (Spanish)
Toda la documentación detallada y guías en español están disponibles en:
👉 **[docs-es/README.md](docs-es/README.md)**

---

## 🌍 Language Support

| Language | Package Manager | Status |
| :--- | :--- | :--- |
| **Python** (3.8+) | PyPI | ✅ Available (`pip install mmex-lib`) |
| **Rust** | crates.io | ✅ Available (`cargo add mmex-lib`) |
| **Kotlin/JVM** | Maven Central | ⏳ Coming soon... |

---

## 🚀 Quick Start (Python)

The easiest way to use `mmex_lib` is through Python.

### Installation

Install the library directly from PyPI:

```bash
pip install mmex-lib
```

### Usage

```python
import mmex_lib

# Initialize the engine (path to .mmb file, password if encrypted)
engine = mmex_lib.MmexEngine("my_finance.mmb", None)

# Access account manager and get all accounts
accounts = engine.accounts().get_all_accounts()

print(f"Found {len(accounts)} accounts:")
for account in accounts:
    print(f"- {account.name} (Initial Balance: {account.initial_balance})")
```

For more details, see the [Python Getting Started Guide](docs/guides/getting_started_python.md).

---

## 📊 Feature Matrix (Beta)

| Module | Status | Description |
| :--- | :--- | :--- |
| **Accounts** | ⚠️ Beta | Account CRUD and balance calculations. |
| **Transactions** | ⚠️ Beta | Income, expenses, and transfers management. |
| **Categories** | ⚠️ Beta | Hierarchical category management. |
| **Currencies** | ⚠️ Beta | Currency and exchange rate management. |
| **Assets** | 🧪 Alpha | Fixed assets tracking. |
| **Stocks** | 🧪 Alpha | Stock portfolio management. |

---

## 🏗 Development & Contributing

If you want to build the library from source or contribute to its development, please refer to the documentation:

- [Project Architecture (ES)](docs-es/architecture/overview.md)
- [Contributing Guide (ES)](docs-es/CONTRIBUTING.md)

### Building from source (Python)

```bash
make setup      # Complete setup (venv + deps + lib compilation)
make develop    # Recompile after Rust changes
make test       # Run all tests (Rust + Python)
```

## 📄 License
Check the LICENSE file for details.