Merge branch 'release/v1.5.2'

Author: RamezIssac

CHANGELOG.md

@@ -1,6 +1,19 @@
 # Changelog
 All notable changes to this project are/will be documented in this file.
 
+## [1.5.2] - 2023-06-07
+- Added Jazzmin integration as an option
+- Added settings for custom dashboard base template, admin_site_access_permission, report_access_function 
+- Simplified creating a widget for a report
+- Simplified integrating erp framework with your project
+- Align own ReportView to Slick Reporting ReportView
+- Removed ReportList View, top_search app, and unused js plugins
+- Changed report URL to be app_label/report_lug
+- Enhanced demo app and documentation
+
+## [1.5.0] - 2023-05-28
+- A makeover and renaming the project to django-erp-framework.
+
 
 ## [1.2.0] - 2020-11-24
 - Update slick_reporting to version >= 0.4

docs/source/Walkthrough.rst

@@ -4,19 +4,36 @@ Walkthrough
 =============
 
 
-Log in to My Shop demo site "My Shop" https://my-shop.django-erp-framework.com/  with the following credentials:
+Log in to "My Shop", our demo site  https://my-shop.django-erp-framework.com/  with the following credentials:
 
 Username `test`
 
 Password `testuser123`
 
 This is a custom admin site with a dashboard and reporting. :ref:`erp_admin`
 
-In the dashboard You see reports displayed as widgets:
+The demo site contains 3 dashboards:
+
+1. The default dashboard, with jazzmin theme (https://my-shop.django-erp-framework.com/)
+   The dashboard is for a sample ERP site, with a few widgets and reports.
+
+2. A custom dashboard with a custom index template (https://my-shop.django-erp-framework.com/requests-dashboard/)
+   This dashboard is for the requests app https://github.com/django-request/django-request
+   It's using a custom base template, like what you'd need to integrate this project into your own site.
+
+3. A custom dashboard created without the erp admin site.
+   A demo of how to use the framework in your own views and templates.
+
+
+In the default dashboard You see reports displayed as widgets:
 
 #. Expense total
-#. Profitability Monthly
+#. Profitability Monthly (A time series report)
 #. Sales list
+#. Product Movement Statement (debit and credit transactions)
+#. A custom success call back to display the ajax json response of the report
+#. Product Client Sales Comparision (A cross tab report)
+
 
 
 .. image:: _static/widgets.png
@@ -33,7 +50,7 @@ In the dashboard You see reports displayed as widgets:
 
 Apps
 ----
-My Shop is composed of 3 apps to demo django erp framework
+My Shop default dashboard is composed of 3 apps to demo django erp framework
 Expense, Sales & Purchase
 
 #. Expense:

docs/source/getting_started/index.rst

@@ -20,25 +20,24 @@ Usage
 .. code-block:: python
 
     INSTALLED_APPS = {
-        # ...
 
 
-        'crequest',
-        'crispy_forms',
+        'crequest', # Need access to the request object in places where request
+
+        'crispy_forms', # For the reports forms,
         'crispy_bootstrap4',
 
-        'reversion', # needed only when you add the admin app
-        'tabular_permissions',
+        'reversion', # needed only when you use the admin app
+        'tabular_permissions', # better a permission widget , Optional
 
         'erp_framework',
+        "erp_framework.admin.jazzmin_integration", # if you want to use jazzmin theme, otherwise remove this line
         'erp_framework.admin',
-        'erp_framework.activity',
         'erp_framework.reporting',
         'slick_reporting',
 
-        'jazzmin',
+        'jazzmin', # optional
         'django.contrib.admin', # comes at the end because the theme is replaced
-
     }
 
 
@@ -53,7 +52,7 @@ Usage
 
 
 
-* Django-erp-framework uses django-crispy-forms for the reporting forms. So we need to add this:
+* Django-erp-framework uses django-crispy-forms for the reporting forms. So we need to add this to our settings.py:
 
 .. code-block:: python
 
@@ -69,8 +68,6 @@ Usage
         "site_name": "ERP Framework System",
         "site_header": "ERP Framework System",
         "index_title": "ERP Framework Dashboard",
-
-        # .. todo
     }
 
 
@@ -97,21 +94,11 @@ We need to hook the Django ERP admin site in ``urls.py``, like so:
 
 With this configuration in place, you are ready to run ``./manage.py migrate``
 
-User accounts
--------------
-
-Superuser accounts receive automatic access to the Django ERP framework Dashboard interface; use ``./manage.py createsuperuser`` if you don't already have one.
-
-Start developing
-----------------
-
-You're now ready to add a new app to your Django project via ``./manage.py startapp``.
 
 Follow to the tutorial to create sample erp system which tracks sales and expense and profitability. :ref:`tutorial_root`
 
 
 
-
 Running the tests
 -----------------
 

docs/source/index.rst

@@ -1,14 +1,15 @@
 Welcome to Django ERP framework documentation
 =============================================
 
-A light-weight effective framework to create business application equipped with a reporting engine and a responsive dashboard written in `Python <https://www.python.org/>`_ and built on the `Django web framework <https://www.djangoproject.com/>`_.
+A light-weight effective framework to create reports, dashboards and diverse business and ERP applications written in `Python <https://www.python.org/>`_ and built on top of `Django web framework <https://www.djangoproject.com/>`_.
 
 Features
 --------
 
 - A Reporting Engine that can generate reports like time series , crosstab , and more. from any model.
 - Charting capabilities built in to turn reports into attractive charts.
 - Widget system to display bits of the reports results or its charts on any page you want.
+- A Dashboard system allowing you to create different dashboards for different users/ cases .
 - Customizable and easily extensible.
 - Django Jazzmin theme ready (& can be used with any django admin theme)
 - Python 3.8 / 3.9 / 3.10

docs/source/release_notes/release_1.5.2.rst

@@ -0,0 +1,11 @@
+V1.5.2 (07 June 2023)
+====================
+
+- Added Jazzmin integration as an option
+- Added settings for custom dashboard base template, admin_site_access_permission, report_access_function
+- Simplified creating a widget for a report
+- Simplified integrating erp framework with your project
+- Align own ReportView to Slick Reporting ReportView
+- Removed ReportList View, top_search app, and unused js plugins
+- Changed report URL to be app_label/report_lug
+- Enhanced demo app and documentation

docs/source/settings.py

@@ -0,0 +1,129 @@
+"""
+Settings for the documentation builder.
+"""
+
+import os
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "1han1v%@fd0#e40#tm0z!g2twgo3+!gf9-kr3--1v5)_bkfv4q"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = ["*"]
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "crequest",
+    "crispy_forms",
+    "reversion",
+    "tabular_permissions",
+    "erp_framework",
+    # "erp_framework.admin",
+    # "erp_framework.activity",
+    "erp_framework.reporting",
+    "slick_reporting",
+    "jazzmin",
+    "django.contrib.admin",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "crequest.middleware.CrequestMiddleware",
+]
+
+ROOT_URLCONF = "myproject.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+                "django.template.context_processors.i18n",
+                "django.template.context_processors.static",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "myproject.wsgi.application"
+
+# Password validation
+# https://docs.djangoproject.com/en/2.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+# Internationalization
+# https://docs.djangoproject.com/en/2.2/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/2.2/howto/static-files/
+
+STATIC_URL = "/static/"
+
+# Database
+# https://docs.djangoproject.com/en/2.2/ref/settings/#databases
+
+
+STATIC_ROOT = os.path.join(BASE_DIR, "..", "collected_static")
+CRISPY_TEMPLATE_PACK = "bootstrap4"
+
+LOGIN_REDIRECT_URL = "/"
+
+# RA_ADMIN_INDEX_PAGE = 'ra_demo/index.html'
+
+ERP_ADMIN_SITE_TITLE = "my demo "
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": os.path.join(BASE_DIR, "erp_framework.sqlite3"),
+    }
+}

docs/source/topics/widgets.rst

@@ -11,11 +11,11 @@ Adding a widget to a page is as easy as this code
 
         <div class="widget-container">
             {% get_report base_model='expense' report_slug='ExpensesTotalStatement' as ExpensesTotalStatement %}
-            {% get_html_panel ExpensesTotalStatement %}
+            {% get_widget ExpensesTotalStatement %}
         </div>
 
 The ``get_report`` tag will return a ``Report`` object that can be used to
-render the report. The ``get_html_panel`` tag will render
+render the report. The ``get_widget`` tag will render
 the report as a card with a title, a table and a chart container.
 
 This code above will be actually rendered as this in the html page:
@@ -68,10 +68,23 @@ container for the chart. The ``data-report-table`` attribute is used by the
 javascript to find the container for the table.
 
 
-get_html_panel Tag can accept a ``template_name`` parameter to render the
+``get_widget`` Tag can accept a ``template_name`` parameter to render the
 report using a custom template. By default it renders the
 ``erp_reporting/report_widget.html`` template.
 
+Default Arguments
+-----------------
+
+extra_params
+success_callback
+failure_callback
+display_chart
+display_table
+chart_id
+display_title
+title (default to report report title)
+
+
 
 
 

erp_framework/utils/__init__.py docs/source/tutorial/dashboard.rsterp_framework/utils/__init__.py renamed to docs/source/tutorial/dashboard.rst

@@ -1,5 +1,5 @@
 # default_app_config = "erp_framework.apps.RaConfig"
 
-VERSION = (1, 5, 0)
+VERSION = (1, 5, 2)
 
-__version__ = "1.5.0"
+__version__ = "1.5.2"