Documentation Update

Author: elarroba

django_ledger/settings.py

@@ -31,7 +31,7 @@
 
 logger.info(f'Django Ledger GraphQL Enabled: {DJANGO_LEDGER_GRAPHQL_SUPPORT_ENABLED}')
 
-DJANGO_LEDGER_USE_CLOSING_ENTRIES = getattr(settings, 'DJANGO_LEDGER_USE_CLOSING_ENTRIES', False)
+DJANGO_LEDGER_USE_CLOSING_ENTRIES = getattr(settings, 'DJANGO_LEDGER_USE_CLOSING_ENTRIES', True)
 DJANGO_LEDGER_DEFAULT_CLOSING_ENTRY_CACHE_TIMEOUT = getattr(settings,
                                                             'DJANGO_LEDGER_DEFAULT_CLOSING_ENTRY_CACHE_TIMEOUT', 3600)
 DJANGO_LEDGER_LOGIN_URL = getattr(settings, 'DJANGO_LEDGER_LOGIN_URL', settings.LOGIN_URL)

docs/source/index.rst

@@ -13,10 +13,13 @@ Django Ledger - The Django Book Keeping Engine.
    :maxdepth: 2
    :caption: Contents:
 
+   ./README.md
    ./quickstart
+   ./io
    ./models
 
 
+
 Indices and tables
 ==================
 

docs/source/io.rst

@@ -0,0 +1,7 @@
+IO Engine
+=========
+
+IO MixIn
+--------
+.. automodule:: django_ledger.io.io_mixin
+    :members:

docs/source/quickstart.rst

@@ -2,5 +2,4 @@ Quickstart
 ==========
 
 .. toctree::
-    ./README.md
     ./quickstart_notebook.md

docs/source/quickstart_notebook.md

@@ -35,22 +35,26 @@ from django_ledger.io import roles
 
 ```python
 # change this to your preferred django username...
-MY_USERNAME = 'elarroba'
+MY_USERNAME = 'ceo_user'
+MY_PASSWORD = 'NeverUseMe|VeryInsecure!'
 UserModel = get_user_model()
-user_model = UserModel.objects.get(username__exact=MY_USERNAME)
+
+try:
+    user_model = UserModel.objects.get(username__exact=MY_USERNAME)
+except:
+    user_model = UserModel.objects.create(username=MY_USERNAME, password=MY_PASSWORD)
 ```
 
 # Create an Entity Model
 
 
 ```python
-entity_model = EntityModel(
+entity_model = EntityModel.create_entity(
     name='One Big Company, LLC',
     admin=user_model,
-    accrual_method=True
+    use_accrual_method=True,
+    fy_start_month=1
 )
-entity_model.clean()
-entity_model = EntityModel.add_root(instance=entity_model)
 ```
 
 
@@ -70,9 +74,10 @@ entity_model.has_default_coa()
 
 ```python
 default_coa_model = entity_model.create_chart_of_accounts(
-    assign_as_default=True, 
-    commit=True, 
-    coa_name='My QuickStart CoA')
+    assign_as_default=True,
+    commit=True,
+    coa_name='My QuickStart CoA'
+)
 ```
 
 
@@ -113,9 +118,10 @@ default_coa_model = entity_model.get_default_coa()
 
 ```python
 another_coa_model = entity_model.create_chart_of_accounts(
-    assign_as_default=False, 
-    commit=True, 
-    coa_name='My Legacy Chart of Accounts')
+    assign_as_default=False,
+    commit=True,
+    coa_name='My Legacy Chart of Accounts'
+)
 ```
 
 # Accounts
@@ -128,9 +134,10 @@ coa_qs, coa_map = entity_model.get_all_coa_accounts()
 pd.DataFrame(coa_map[default_coa_model].values())
 ```
 
+### New CoA does not have any accounts yet...
+
 
 ```python
-# new CoA does not have any accounts yet...
 pd.DataFrame(coa_map[another_coa_model].values())
 ```
 
@@ -166,13 +173,6 @@ coa_accounts_by_coa_slug_qs = entity_model.get_coa_accounts(coa_model=default_co
 pd.DataFrame(coa_accounts_by_coa_slug_qs.values())
 ```
 
-
-```python
-# coa_accounts_by_codes_qs = entity_model.get_accounts_with_codes(code_list=['ABC'], 
-#                                                                 coa_model=another_coa_model)
-# pd.DataFrame(coa_accounts_by_codes_qs.values())
-```
-
 ## Get Accounts With Codes and CoA Model
 
 
@@ -188,7 +188,7 @@ pd.DataFrame(coa_accounts_by_codes_qs.values())
 coa_model, account_model = entity_model.create_account(
     coa_model=another_coa_model,
     account_model_kwargs={
-        'code': f'1{str(randint(10000,99999))}ABC',
+        'code': f'1{str(randint(10000, 99999))}ABC',
         'role': roles.ASSET_CA_INVENTORY,
         'name': 'A cool account created from the EntityModel API!',
         'balance_type': roles.DEBIT,
@@ -203,8 +203,8 @@ account_model
 
 
 ```python
-given_coa_accounts_qs = entity_model.get_coa_accounts(coa_model=another_coa_model)
-pd.DataFrame(given_coa_accounts_qs.values())
+another_coa_accounts_qs = entity_model.get_coa_accounts(coa_model=another_coa_model)
+pd.DataFrame(another_coa_accounts_qs.values())
 ```
 
 # Customers
@@ -269,7 +269,7 @@ invoice_model = entity_model.create_invoice(
 
 
 ```python
-# invoice_model.
+invoice_model
 ```
 
 ## Add Items to Invoices
@@ -278,6 +278,7 @@ invoice_model = entity_model.create_invoice(
 ```python
 invoices_item_models = invoice_model.get_item_model_qs()
 
+# K= number of items...
 K = 6
 
 invoice_itemtxs = {
@@ -320,6 +321,11 @@ bill_model = entity_model.create_bill(
 )
 ```
 
+
+```python
+bill_model
+```
+
 ## Add Items to Bills
 
 
@@ -410,7 +416,7 @@ pd.DataFrame(estimates_qs.values())
 
 ```python
 estimate_model = entity_model.create_estimate(
-    estimate_title='A quote for new potential customer!', 
+    estimate_title='A quote for new potential customer!',
     customer_model='C-0000000009',
     contract_terms=EstimateModel.CONTRACT_TERMS_FIXED
 )
@@ -619,11 +625,13 @@ inventory_model.is_inventory()
 
 ```python
 bs_report = entity_model.get_balance_sheet_statement(
-    to_date=date(2022,12,31),
+    to_date=date(2022, 12, 31),
     save_pdf=True,
+    filepath='./'
 )
 # save_pdf=True saves the PDF report in the project's BASE_DIR.
 # filename and filepath may also be specified...
+# will raise not implemented error if PDF support is not enabled...
 ```
 
 ### Balance Sheet Statement Raw Data
@@ -638,12 +646,14 @@ bs_report.get_report_data()
 
 ```python
 ic_report = entity_model.get_income_statement(
-    from_date=date(2022,1,1),
-    to_date=date(2022,12,31),
-    save_pdf=True
+    from_date=date(2022, 1, 1),
+    to_date=date(2022, 12, 31),
+    save_pdf=True,
+    filepath='./'
 )
 # save_pdf=True saves the PDF report in the project's BASE_DIR.
 # filename and filepath may also be specified...
+# will raise not implemented error if PDF support is not enabled...
 ```
 
 ### Income Statement Raw Data
@@ -658,9 +668,10 @@ ic_report.get_report_data()
 
 ```python
 cf_report = entity_model.get_cash_flow_statement(
-    from_date=date(2022,1,1),
-    to_date=date(2022,12,31),
-    save_pdf=True
+    from_date=date(2022, 1, 1),
+    to_date=date(2022, 12, 31),
+    save_pdf=True,
+    filepath='./'
 )
 # save_pdf=True saves the PDF report in the project's BASE_DIR.
 # filename and filepath may also be specified...
@@ -679,9 +690,10 @@ cf_report.get_report_data()
 ```python
 reports = entity_model.get_financial_statements(
     user_model=user_model,
-    from_date=date(2022,1,1),
-    to_date=date(2022,12,31),
-    save_pdf=True
+    from_date=date(2022, 1, 1),
+    to_date=date(2022, 12, 31),
+    save_pdf=True,
+    filepath='./'
 )
 # save_pdf=True saves the PDF report in the project's BASE_DIR.
 # filename and filepath may also be specified...

notebooks/QuickStart Notebook.ipynb

@@ -270,12 +270,15 @@
   },
   {
    "cell_type": "markdown",
+   "metadata": {
+    "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    }
+   },
    "source": [
     "### New CoA does not have any accounts yet..."
-   ],
-   "metadata": {
-    "collapsed": false
-   }
+   ]
   },
   {
    "cell_type": "code",
@@ -678,13 +681,16 @@
   {
    "cell_type": "code",
    "execution_count": null,
+   "metadata": {
+    "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    }
+   },
    "outputs": [],
    "source": [
     "bill_model"
-   ],
-   "metadata": {
-    "collapsed": false
-   }
+   ]
   },
   {
    "cell_type": "markdown",
@@ -1450,11 +1456,14 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "outputs": [],
-   "source": [],
    "metadata": {
-    "collapsed": false
-   }
+    "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    }
+   },
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
@@ -1473,7 +1482,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.3"
+   "version": "3.11.6"
   }
  },
  "nbformat": 4,