How seldon/django-simple-accounting works
Project type and purpose
• This is a reusable Django application (“django-accounting”) that provides a simple accounting model for any Django project.
• It’s not a full-stack product by itself but a backend plugin: it ships models, management commands, admin integration, utilities, and tests.
File structure
• Top-level packaging files: setup.py, MANIFEST.in, REQUIREMENTS.txt, LICENSE, README.rst, CHANGELOG.txt.
• docs/: human-readable design notes (e.g. accounting_model.rst).
• simple_accounting/: the core Django app
• __init__.py, consts.py, exceptions.py, fields.py, lib.py, managers.py, models.py, utils.py
• admin.py: registers models in Django admin
• management/: custom management commands
• tests/: unit tests simulating a host Django project (settings.py, urls.py, views.py, tests.py)
README
• Purpose: supply a Transaction model with configurable TRANSACTION_TYPES
• Key consumption points: Django settings, ORM, admin, and management commands for data loading or reporting.
a. Main components
• Host Django Project (the consumer)
• Django Framework (ORM, model layer, admin, management)
• simple_accounting app
– Models: Transaction, Account, etc.
– Managers & Lib: business-logic methods (e.g. balance computation)
– Admin: model registration & UI
– Management Commands: CLI tools for batch operations or reporting
– Utils & Exceptions: helper functions & error types
• Database (PostgreSQL/MySQL/SQLite)
• Project Settings: includes TRANSACTION_TYPES and INSTALLED_APPS entry
b. Relationships & interactions
1. At startup, Django reads settings.py → INSTALLED_APPS includes simple_accounting
2. Models are registered in the ORM → migrations → DB schema
3. Admin module registers model → admin site UI → Web user interaction
4. Management commands invoked via “python manage.py <command>” → load data, generate reports
5. Models.Manager and lib.py provide transaction-level APIs, invoked by views or external scripts
6. Exceptions bubble up to calling code
c. Architectural patterns & design principles
• Layered design: settings → models → managers/lib → utils → exceptions
• Reusable app pattern: clean separation from host project, relies on standard Django hooks
• Configuration by convention: uses Django settings TRANSACTION_TYPES for extensibility
d. Key technologies & libraries
• Python 3.x, Django framework
• Django ORM & Admin
• setuptools for packaging (setup.py)
• Standard management command API
Summary guidance
• Break the app into these logical components: settings, registry, models, admin, managers/lib, utils/exceptions, DB.
• Configuration and extension points (e.g., TRANSACTION_TYPES) so viewers see where to plug in.