Skip to main content

Double entry accounting system built on the Django Web Framework.

Project description

django ledger logo

Django Ledger

A Double Entry Accounting Engine for Django

Django Ledger is a powerful financial management system built on the Django Web Framework. It offers a simplified API for handling complex accounting tasks in financially driven applications.

Created and developed by Miguel Sanda.

FREE Get Started Guide | Join our Discord | Documentation | QuickStart Notebook

Key Features

  • High-level API
  • Double entry accounting
  • Hierarchical Chart of Accounts
  • Financial statements (Income Statement, Balance Sheet, Cash Flow)
  • Purchase Orders, Sales Orders, Bills, and Invoices
  • Financial ratio calculations
  • Multi-tenancy support
  • Ledgers, Journal Entries & Transactions
  • OFX & QFX file import
  • Closing Entries
  • Inventory management
  • Unit of Measures
  • Bank account information
  • Django Admin integration
  • Built-in Entity Management UI

Getting Involved

All pull requests are welcome, as long as they address bugfixes, enhancements, new ideas, or add value to the project in any shape or form. Please refrain from submitting pull requests that focus solely on code linting, refactoring, or similar cosmetic changes.

Who Should Contribute?

We're looking for contributors with:

  • Python and Django programming skills
  • Finance and accounting expertise
  • Interest in developing a robust accounting engine API

If you have relevant experience, especially in accounting, we welcome your pull requests or direct contact.

Installation

Django Ledger is a Django application. If you haven't, you need working knowledge of Django and a working Django project before you can use Django Ledger. A good place to start is here.

Make sure you refer to the django version you are using.

The easiest way to start is to use the zero-config Django Ledger starter template. See details here. Otherwise, you may create your project from scratch.

To create a new Django Ledger project:

  • Make sure you have the latest version of python here (recommended).

  • Install Django:

pip install django
  • Install Python Pipenv (python package manager):
pip install pipenv
  • Go to your desired development folder and create a new django project:
django-admin startproject django_ledger_project && cd django_ledger_project
  • Install Django on you virtual environment.
pipenv install django
  • Install Django Ledger
pipenv install "django-ledger[graphql,pdf]"

Alternatively, you can use:

pipenv install django-ledger\[graphql,pdf\]
  • Activate your new virtual environment:
pipenv shell
  • Add django_ledger to INSTALLED_APPS in you new Django Project.
INSTALLED_APPS = [
    ...,
    'django_ledger',
    ...,
]
  • Perform database migrations:
python manage.py migrate
  • Add Django SuperUser and follow the prompts.
python manage.py createsuperuser
  • Add URLs to your project's urls.py:
from django.urls import include, path

urlpatterns = [
    ...,
    path('ledger/', include('django_ledger.urls', namespace='django_ledger')),
    ...,
]
  • Run your project:
python manage.py runserver
  • Navigate to Django Ledger root view assigned in your project urlpatterns setting ( typically http://127.0.0.1:8000/ledger if you followed this installation guide).
  • Use your superuser credentials to login.

How To Set Up Django Ledger for Development

Django Ledger comes with a basic development environment already configured under dev_env/ folder not to be used for production environments. If you want to contribute to the project perform the following steps:

  1. Navigate to your projects directory.
  2. Clone the repo from github and CD into project.
git clone https://github.com/arrobalytics/django-ledger.git && cd django-ledger
  1. Install PipEnv, if not already installed:
pip install -U pipenv
  1. Create virtual environment.
pipenv install

If using a specific version of Python you may specify the path.

pipenv install --python PATH_TO_INTERPRETER
  1. Activate environment.
pipenv shell
  1. Apply migrations.
python manage.py migrate
  1. Create a Development Django user.
python manage.py createsuperuser
  1. Run development server.
python manage.py runserver

How To Set Up Django Ledger for Development using Docker

  1. Navigate to your projects directory.

  2. Give executable permissions to entrypoint.sh

sudo chmod +x entrypoint.sh
  1. Add host '0.0.0.0' into ALLOWED_HOSTS in settings.py.

  2. Build the image and run the container.

docker compose up --build
  1. Add Django Superuser by running command in seprate terminal
docker ps

Select container id of running container and execute following command

docker exec -it containerId /bin/sh
python manage.py createsuperuser
  1. Navigate to http://0.0.0.0:8000/ on browser.

Run Test Suite

After setting up your development environment you may run tests.

python manage.py test django_ledger

Screenshots

django ledger entity dashboard django ledger balance sheet django ledger income statement django ledger bill django ledger invoice

Financial Statements Screenshots

balance_sheet_report income_statement_report cash_flow_statement_report

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

django_ledger-0.7.8-py3-none-any.whl (2.7 MB view details)

Uploaded Python 3

File details

Details for the file django_ledger-0.7.8-py3-none-any.whl.

File metadata

  • Download URL: django_ledger-0.7.8-py3-none-any.whl
  • Upload date:
  • Size: 2.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for django_ledger-0.7.8-py3-none-any.whl
Algorithm Hash digest
SHA256 3a335162cfefedd50f83966d8c373c90b450f6afce76d4567525450ad55cf8bf
MD5 1e91fe753a70f14989649052c9ab2c68
BLAKE2b-256 6eeebda575f6be38a5b295e5242215ef59765b6c8e0604a0f9dbafc0a256a916

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page