Metadata-Version: 2.2
Name: django-coasc
Version: 0.1.1
Summary: Django application providing a solid foundation for double-entry bookkeeping systems
Author: Suresh Thagunna
Project-URL: Homepage, https://github.com/suresh466/django-coasc
Keywords: django,accounting,bookkeeping,double-entry,finance,cooperative
Requires-Python: >=3.13
Description-Content-Type: text/markdown
Requires-Dist: django>=5.1.7

# Django-coasc
Double entry bookkeeping in Django. Inspired by [Django-hordak](https://github.com/adamcharnock/django-hordak) and [gnucash](https://github.com/Gnucash/gnucash)

Django-coasc provides a model layer for a double-entry accounting system, primarily aimed at cooperative organizations but suitable for various accounting needs.

## The goal
A simple and well tested core to build double entry system accounting apps upon.

## Interface built upon Django-coasc:
>[COASV](https://github.com/suresh466/coasv) Accounting app for Cooperatives

### Using Django-coasc in your project


Install with [uv](https://github.com/astral-sh/uv)

```bash
uv add django-coasc
```

Install Django-coasc using pip:

```bash
pip install django-coasc
```

Add `coasc` to your `INSTALLED_APPS` in Django settings:

```python
INSTALLED_APPS = [
    # ...
    'coasc',
    # ...
]
```

Run migrations:

```bash
# If using standard Python
python manage.py migrate coasc

# If using uv
uv run ./manage.py migrate coasc
```

## Features

- **Double-entry bookkeeping** - Each transaction must have balanced debits and credits
- **Hierarchical accounts** - Support for parent and child account relationships
- **Multiple account types** - Assets, Liabilities, Income, and Expenses
- **Transaction validation** - Ensures accounting integrity
- **Balance calculation** - Methods to calculate account balances with optional date filters
- **Revertible transactions** - Built-in support for reverting transactions

## Core Components

- **Member**: Represents individuals or entities associated with accounts
- **Ac (Account)**: The core entity representing different types of accounts
  - Parent accounts - Group related accounts
  - Child accounts - Belong to a parent account
  - Standalone accounts - Independent accounts
- **Transaction**: Represents financial transactions
- **Split**: Represents individual debit or credit entries within a transaction

### Terminology

COASC: Cooperative Accounting System Core
COASV: Cooperative Accounting System View

## TODOs
1. add comments where appropriate
5. write tests for date filtered bal and total_bal()
6. modify tests for transaction(renamed date_created to created_at and add tx_date field)
