django-ledger 0.5.2.6__tar.gz → 0.8.1__tar.gz

{django-ledger-0.5.2.6 → django_ledger-0.8.1}/AUTHORS.md

@@ -7,12 +7,18 @@ Django Ledger was created by [Miguel Sanda](https://github.com/elarroba).
 ### Project Maintainers
 * Miguel Sanda [@elarroba](https://github.com/elarroba)
 
-### Developers & Contributors
+### Developers
 * Miguel Sanda [@elarroba](https://github.com/elarroba)
+
+### Contributors
 * Michael Noel [@mnooel](https://github.com/mnooel)
 * Eric Owuor [@Ericpaul](https://github.com/25-do)
+* Pranav P Tulshyan
 
 ### Accountants, CPAs & Bookkeepers
 * Miguel Sanda [@elarroba](https://github.com/elarroba)
 * Albert Salazar [@Beachwood619](https://github.com/Beachwood619)
-* Michael Noel, CPA [@mnooel](https://github.com/mnooel) 
+* Michael Noel, CPA [@mnooel](https://github.com/mnooel) 
+
+### Documentation Contributors
+* Miguel Sanda [@elarroba](https://github.com/elarroba)

django_ledger-0.8.1/MANIFEST.in

@@ -0,0 +1,8 @@
+recursive-include django_ledger/templates *
+recursive-include django_ledger/static *
+
+prune dev_env
+prune docs
+prune assets
+prune docs.source
+prune notebooks

django_ledger-0.8.1/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: django-ledger
+Version: 0.8.1
+Summary: Double entry accounting system built on the Django Web Framework.
+Author-email: Miguel Sanda <msanda@arrobalytics.com>
+Maintainer-email: Miguel Sanda <msanda@arrobalytics.com>
+License: GPLv3 License
+Project-URL: Homepage, https://www.djangoledger.com
+Project-URL: Bug Tracker, https://github.com/arrobalytics/django-ledger/issues
+Project-URL: Documentation, https://django-ledger.readthedocs.io/en/latest/
+Project-URL: Source Code, https://github.com/arrobalytics/django-ledger
+Keywords: django,finance,bookkeeping,accounting,balance sheet,income statement,general ledger,money,engine
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 5.0
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.md
+Requires-Dist: django>=4.2
+Requires-Dist: django-treebeard>=4.7.1
+Requires-Dist: faker>=37.6.0
+Requires-Dist: fpdf2>=2.8.4
+Requires-Dist: markdown>=3.9
+Requires-Dist: ofxtools>=0.9.5
+Requires-Dist: pillow>=11.3.0
+Dynamic: license-file
+
+![django ledger logo](https://us-east-1.linodeobjects.com/django-ledger/logo/django-ledger-logo@2x.png)
+
+# 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](https://www.miguelsanda.com).
+
+[FREE Get Started Guide](https://www.djangoledger.com/get-started) | [Join our Discord](https://discord.gg/c7PZcbYgrc) | [Documentation](https://django-ledger.readthedocs.io/en/latest/) | [QuickStart Notebook](https://github.com/arrobalytics/django-ledger/blob/develop/notebooks/QuickStart%20Notebook.ipynb)
+
+## 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, auto-generated code,
+refactoring, or similar cosmetic non-value add changes.
+
+- **Feature Requests/Bug Reports**: Open an issue in the repository
+- **For software customization, advanced features and consulting services**:
+  [Contact us](https://www.miguelsanda.com/work-with-me/) or email msanda@arrobalytics.com
+- **Contribute**: See
+  our [contribution guidelines](https://github.com/arrobalytics/django-ledger/blob/master/Contribute.md)
+
+## 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](https://www.djangoproject.com/) 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](https://docs.djangoproject.com/en/4.2/intro/tutorial01/#creating-a-project).
+
+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](https://github.com/arrobalytics/django-ledger-starter).
+Otherwise, you may create your project from scratch.
+
+## Adding Django Ledger to an existing project.
+
+### Add django_ledger to INSTALLED_APPS in you new Django Project.
+
+```python
+INSTALLED_APPS = [
+    ...,
+    'django_ledger',
+    ...,
+]
+```
+
+### Add Django Ledger Context Preprocessor
+
+```python
+TEMPLATES = [
+    {
+        'OPTIONS': {
+            'context_processors': [
+                '...',
+                'django_ledger.context.django_ledger_context'  # Add this line to a context_processors list..
+            ],
+        },
+    },
+]
+```
+
+### Perform database migrations:
+
+```shell
+python manage.py migrate
+```
+
+* Add URLs to your project's __urls.py__:
+
+```python
+from django.urls import include, path
+
+urlpatterns = [
+    ...,
+    path('ledger/', include('django_ledger.urls', namespace='django_ledger')),
+    ...,
+]
+```
+
+### Run your project:
+
+```shell
+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.
+
+## Deprecated behavior setting (v0.8.0+)
+
+Starting with version v0.8.0, Django Ledger introduces the DJANGO_LEDGER_USE_DEPRECATED_BEHAVIOR setting to control
+access to deprecated features and legacy behaviors.
+
+- Default: False (deprecated features are disabled by default)
+- To temporarily keep using deprecated features while you transition, set this to True in your Django settings.
+
+## Setting 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.
+
+```shell
+git clone https://github.com/arrobalytics/django-ledger.git && cd django-ledger
+```
+
+3. Install PipEnv, if not already installed:
+
+```shell
+pip install -U pipenv
+```
+
+4. Create virtual environment.
+
+```shell
+pipenv install
+```
+
+If using a specific version of Python you may specify the path.
+
+```shell
+pipenv install --python PATH_TO_INTERPRETER
+```
+
+5. Activate environment.
+
+```shell
+pipenv shell
+```
+
+6. Apply migrations.
+
+```shell
+python manage.py migrate
+```
+
+7. Create a Development Django user.
+
+```shell
+python manage.py createsuperuser
+```
+
+8. Run development server.
+
+```shell
+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
+
+```shell
+sudo chmod +x entrypoint.sh
+```
+
+3. Add host '0.0.0.0' into ALLOWED_HOSTS in settings.py.
+
+4. Build the image and run the container.
+
+```shell
+docker compose up --build
+```
+
+5. Add Django Superuser by running command in seprate terminal
+
+```shell
+docker ps
+```
+
+Select container id of running container and execute following command
+
+```shell
+docker exec -it containerId /bin/sh
+```
+
+```shell
+python manage.py createsuperuser
+```
+
+6. Navigate to http://0.0.0.0:8000/ on browser.
+
+# Run Test Suite
+
+After setting up your development environment you may run tests.
+
+```shell
+python manage.py test django_ledger
+```
+
+# Screenshots
+
+![django ledger entity dashboard](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_entity_dashboard.png)
+![django ledger balance sheet](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_income_statement.png)
+![django ledger income statement](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_balance_sheet.png)
+![django ledger bill](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_bill.png)
+![django ledger invoice](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_invoice.png)
+
+# Financial Statements Screenshots
+
+![balance_sheet_report](https://django-ledger.us-east-1.linodeobjects.com/public/img/BalanceSheetStatement.png)
+![income_statement_report](https://django-ledger.us-east-1.linodeobjects.com/public/img/IncomeStatement.png)
+![cash_flow_statement_report](https://django-ledger.us-east-1.linodeobjects.com/public/img/CashFlowStatement.png)

django_ledger-0.8.1/README.md

@@ -0,0 +1,242 @@
+![django ledger logo](https://us-east-1.linodeobjects.com/django-ledger/logo/django-ledger-logo@2x.png)
+
+# 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](https://www.miguelsanda.com).
+
+[FREE Get Started Guide](https://www.djangoledger.com/get-started) | [Join our Discord](https://discord.gg/c7PZcbYgrc) | [Documentation](https://django-ledger.readthedocs.io/en/latest/) | [QuickStart Notebook](https://github.com/arrobalytics/django-ledger/blob/develop/notebooks/QuickStart%20Notebook.ipynb)
+
+## 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, auto-generated code,
+refactoring, or similar cosmetic non-value add changes.
+
+- **Feature Requests/Bug Reports**: Open an issue in the repository
+- **For software customization, advanced features and consulting services**:
+  [Contact us](https://www.miguelsanda.com/work-with-me/) or email msanda@arrobalytics.com
+- **Contribute**: See
+  our [contribution guidelines](https://github.com/arrobalytics/django-ledger/blob/master/Contribute.md)
+
+## 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](https://www.djangoproject.com/) 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](https://docs.djangoproject.com/en/4.2/intro/tutorial01/#creating-a-project).
+
+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](https://github.com/arrobalytics/django-ledger-starter).
+Otherwise, you may create your project from scratch.
+
+## Adding Django Ledger to an existing project.
+
+### Add django_ledger to INSTALLED_APPS in you new Django Project.
+
+```python
+INSTALLED_APPS = [
+    ...,
+    'django_ledger',
+    ...,
+]
+```
+
+### Add Django Ledger Context Preprocessor
+
+```python
+TEMPLATES = [
+    {
+        'OPTIONS': {
+            'context_processors': [
+                '...',
+                'django_ledger.context.django_ledger_context'  # Add this line to a context_processors list..
+            ],
+        },
+    },
+]
+```
+
+### Perform database migrations:
+
+```shell
+python manage.py migrate
+```
+
+* Add URLs to your project's __urls.py__:
+
+```python
+from django.urls import include, path
+
+urlpatterns = [
+    ...,
+    path('ledger/', include('django_ledger.urls', namespace='django_ledger')),
+    ...,
+]
+```
+
+### Run your project:
+
+```shell
+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.
+
+## Deprecated behavior setting (v0.8.0+)
+
+Starting with version v0.8.0, Django Ledger introduces the DJANGO_LEDGER_USE_DEPRECATED_BEHAVIOR setting to control
+access to deprecated features and legacy behaviors.
+
+- Default: False (deprecated features are disabled by default)
+- To temporarily keep using deprecated features while you transition, set this to True in your Django settings.
+
+## Setting 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.
+
+```shell
+git clone https://github.com/arrobalytics/django-ledger.git && cd django-ledger
+```
+
+3. Install PipEnv, if not already installed:
+
+```shell
+pip install -U pipenv
+```
+
+4. Create virtual environment.
+
+```shell
+pipenv install
+```
+
+If using a specific version of Python you may specify the path.
+
+```shell
+pipenv install --python PATH_TO_INTERPRETER
+```
+
+5. Activate environment.
+
+```shell
+pipenv shell
+```
+
+6. Apply migrations.
+
+```shell
+python manage.py migrate
+```
+
+7. Create a Development Django user.
+
+```shell
+python manage.py createsuperuser
+```
+
+8. Run development server.
+
+```shell
+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
+
+```shell
+sudo chmod +x entrypoint.sh
+```
+
+3. Add host '0.0.0.0' into ALLOWED_HOSTS in settings.py.
+
+4. Build the image and run the container.
+
+```shell
+docker compose up --build
+```
+
+5. Add Django Superuser by running command in seprate terminal
+
+```shell
+docker ps
+```
+
+Select container id of running container and execute following command
+
+```shell
+docker exec -it containerId /bin/sh
+```
+
+```shell
+python manage.py createsuperuser
+```
+
+6. Navigate to http://0.0.0.0:8000/ on browser.
+
+# Run Test Suite
+
+After setting up your development environment you may run tests.
+
+```shell
+python manage.py test django_ledger
+```
+
+# Screenshots
+
+![django ledger entity dashboard](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_entity_dashboard.png)
+![django ledger balance sheet](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_income_statement.png)
+![django ledger income statement](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_balance_sheet.png)
+![django ledger bill](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_bill.png)
+![django ledger invoice](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_invoice.png)
+
+# Financial Statements Screenshots
+
+![balance_sheet_report](https://django-ledger.us-east-1.linodeobjects.com/public/img/BalanceSheetStatement.png)
+![income_statement_report](https://django-ledger.us-east-1.linodeobjects.com/public/img/IncomeStatement.png)
+![cash_flow_statement_report](https://django-ledger.us-east-1.linodeobjects.com/public/img/CashFlowStatement.png)

{django-ledger-0.5.2.6 → django_ledger-0.8.1}/django_ledger/__init__.py

@@ -1,15 +1,12 @@
 """
 Django Ledger created by Miguel Sanda <msanda@arrobalytics.com>.
 Copyright© EDMA Group Inc licensed under the GPLv3 Agreement.
-
-Contributions to this module:
-Miguel Sanda <msanda@arrobalytics.com>
 """
 
 default_app_config = 'django_ledger.apps.DjangoLedgerConfig'
 
 """Django Ledger"""
-__version__ = '0.5.2.6'
+__version__ = '0.8.1'
 __license__ = 'GPLv3 License'
 
 __author__ = 'Miguel Sanda'

django_ledger-0.8.1/django_ledger/admin/__init__.py

@@ -0,0 +1,10 @@
+from django.contrib import admin
+
+from django_ledger.admin.chart_of_accounts import ChartOfAccountsModelAdmin
+from django_ledger.admin.entity import EntityModelAdmin
+from django_ledger.admin.ledger import LedgerModelAdmin
+from django_ledger.models import EntityModel, ChartOfAccountModel, LedgerModel
+
+admin.site.register(EntityModel, EntityModelAdmin)
+admin.site.register(ChartOfAccountModel, ChartOfAccountsModelAdmin)
+admin.site.register(LedgerModel, LedgerModelAdmin)