django-sastry 1.0.0__tar.gz

django_sastry-1.0.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Krishnamurthy (Global Multimedia)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

django_sastry-1.0.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include LICENSE
+include README.md
+include pyproject.toml
+recursive-include sastry/static *
+recursive-include sastry/jinja2 *
+recursive-include sastry/templates *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+

django_sastry-1.0.0/PKG-INFO

@@ -0,0 +1,262 @@
+Metadata-Version: 2.4
+Name: django-sastry
+Version: 1.0.0
+Summary: A lightweight zero-config dynamic CRUD admin interface and interactive visual Entity Relations (ER) diagram for Django.
+Author-email: Krishnamurthy <krishna@globalmultimedia.in>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/globalkrishna/django-sastry
+Project-URL: Repository, https://github.com/globalkrishna/django-sastry.git
+Keywords: django,admin,crud,entity-relationship,er-diagram,schema,database,orm
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=4.2
+Dynamic: license-file
+
+# Django Sastry (django-sastry)
+
+[![CI](https://github.com/globalkrishna/django-sastry/actions/workflows/ci.yml/badge.svg)](https://github.com/globalkrishna/django-sastry/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Python Versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/)
+[![Django Versions](https://img.shields.io/badge/django-4.2%20%7C%205.0%20%7C%205.1-green)](https://www.djangoproject.com/)
+
+A lightweight, zero-configuration dynamic CRUD administration interface and interactive visual **Entity Relations (ER) Diagram** engine for Django.
+
+<p align="center">
+  <img src="docs/images/er_diagram_preview.png" alt="Django Sastry Interactive ER Diagram" width="900" style="border-radius: 8px; box-shadow: 0 4px 12px rgba(0,0,0,0.15);" />
+</p>
+
+---
+
+## Highlights & Features
+
+1. **Interactive Visual Entity Relations (ER) Diagram**:
+   - **Right-Anchored Selected Model**: The active selected table is anchored to the extreme right, directly adjacent to the field inspector panel, with incoming reverse relations (`has_many` / child tables in cyan) and outgoing foreign key targets (in warm tones) plotted across vertical columns to the left.
+   - **Reactive Schema Navigation**: Click any table card or foreign key to immediately make it the active model and move it to the right, refreshing all its upstream and downstream relations.
+   - **Multi-Column Bin-Packing**: Automatically distributes child and referenced tables across vertical columns to the left to prevent tall single-column spillover for heavily connected models.
+   - **Vector Connection Canvas**: Color-coded relational links with directional arrowheads for child table reverse relations and circular anchor nodes for foreign key targets.
+   - **Field-Level Inspector**: Click any field in the active table to view its verbose name, Django internal type, nullability, blankness, uniqueness, database indexes, and reverse references.
+
+2. **Zero-Config Dynamic CRUD**:
+   - Instant spreadsheet-style data grid for all registered Django models without requiring boilerplate `admin.py` registrations.
+   - Paginated browsing, multi-field filtering, search, and inline record creation/editing.
+   - Safe foreign key resolution with query limits preventing unbounded database loads.
+
+3. **Modular ERP Application Foundation**:
+   - Extensible base template hierarchy (`saz3.html` -> `saz3Nav.html` -> `s_home.html`) powering enterprise suites (such as `erp.saas3.in`).
+   - Easily inject custom modules into the navigation bar (Orders, Customer, Inventory, BOM, Sales, Billing).
+   - Reusable `getData` / `mdlData` backend pipelines and subclassable frontend controllers (`class CustomerController extends db_crud`) with custom action triggers (like `#ShowExtraDetail` for Orders).
+
+4. **Lightweight & Non-Intrusive**:
+   - Introspects model structure using Django's native `Model._meta` APIs in memory with zero database queries during diagram generation.
+   - Zero external frontend dependencies: built with modern vanilla ES6 JavaScript and HTML5 Canvas.
+
+---
+
+## The Core Philosophy: The 90/10 Architecture of Database Applications
+
+> *"Most database applications center around selecting some filtered rows, and selecting one of them to view details in a custom way."*
+
+In traditional enterprise software development, building any new module (such as Customer Management, Job Cards, or Fabric Inventory) requires writing substantial boilerplate: API endpoints, pagination, multi-column search, filter drawers, sorting SQL, table HTML, form builders, and relational bindings. This mundane plumbing consumes **80% to 90%** of development time.
+
+**`django-sastry` solves this by inverting the pyramid:**
+- **The 90% (Out-of-the-Box)**: Sastry automatically provides the high-performance relational data grid, instant dynamic search, multi-field filtering, pagination, inline modal editing, and visual ER schema diagram.
+- **The 10% (Your Custom View)**: You only write the domain-specific detail view (an itemized order dossier, a bespoke canvas designer, or a retail invoice).
+
+### The Pattern in Action: A Complete Application in ~40 Lines
+
+#### 1. Backend: Thin View with `getData` (`views.py`)
+```python
+@login_required
+def CustomersList(request, ctyp=0):
+    dat = json.loads(request.GET.get("dat", "{}"))
+    types = CustomerType.objects.all().order_by("name").values_list("id", "name")
+    if not ctyp and types:
+        ctyp = types[0][0]
+    if "filter" not in dat:
+        dat["filter"] = {"customer_type_id": ctyp}
+    dat["show"] = ["id", "customer_id", "name", "city", "state_id"]
+    
+    # Sastry handles the complete query, pagination, sorting, and serialization:
+    data = getData("customer", "Customer", dat)
+    data["ctype"] = types
+    return render(request, "CustomerPage.html", data)
+```
+
+#### 2. Frontend: Subclassing `db_crud` (`customer.ts`)
+```typescript
+import { db_crud } from '/static/sastry/js/s_crud.js';
+
+class CustomerListController extends db_crud<Customer> {
+    constructor() {
+        super();
+        this.setData();
+        // Hook custom filter buttons (e.g. Retail, Wholesale, Distributor)
+        document.querySelectorAll('#FilterType a').forEach(el => {
+            el.onclick = (e) => this.filterByType(e);
+        });
+        // Enable Sastry's built-in toolbar action button for drill-down
+        const extraBtn = document.getElementById("ShowExtraDetail");
+        extraBtn.textContent = "Orders";
+        extraBtn.classList.remove('d-none');
+    }
+
+    ShowTab(tab: string) {
+        super.ShowTab(tab);
+        if (tab !== 'ExtraDetail') return;
+
+        // Retrieve selected row from Sastry's active table
+        const indexRow = document.querySelector('#index tbody tr.table-active') as HTMLTableRowElement;
+        const customer = this.collection[indexRow.rowIndex - 1];
+
+        // Fetch and display the custom detail view for this customer:
+        fetch(`/customer/cust_order/${customer.id}/`)
+            .then(res => res.text())
+            .then(html => {
+                document.getElementById('ExtraDetail')!.innerHTML = html;
+                document.querySelector("#ExtraDetail #Bak2index")!.onclick = () => this.ShowTab('index');
+            });
+    }
+}
+```
+
+By simply writing the custom detail view and connecting it via Sastry's extension points, you achieve a **production-ready, enterprise-grade application** in a few hours.
+
+---
+
+## Documentation & User Manual
+
+For an in-depth walkthrough of the system, including visual diagrams, color specifications, and step-by-step guides for extending Sastry into a custom ERP application, see the official manual:
+
+👉 **[Comprehensive User Manual & ERP Extensibility Guide (docs/USER_MANUAL.md)](docs/USER_MANUAL.md)**
+
+### Manual Highlights:
+- **[Interactive Visual ER Diagram Guide](docs/USER_MANUAL.md#3-interactive-visual-er-diagram)**: Details on the right-anchored model layout, right-to-left multi-column bin packing, color conventions (Gold, Cyan, Amber), and reactive table-clicking.
+- **[Dynamic CRUD Data Grid Guide](docs/USER_MANUAL.md#4-dynamic-crud-data-grid)**: Filtering, sorting, pagination, inline edits, and foreign key optimization.
+- **[ERP Extensibility Guide](docs/USER_MANUAL.md#5-erp-extensibility-guide-the-erpsaas3in-architecture)**: How to hook custom pages from the index navbar (`s_home.html`), author custom views reusing `getData`, build offcanvas filter drawers (`FilterType`), and subclass `db_crud` to display custom buttons like `[⤢ Orders]`.
+- **[Python & JavaScript API Reference](docs/USER_MANUAL.md#7-api-reference)**: Complete function signatures and class definitions.
+
+---
+
+## Installation
+
+Install via pip:
+
+```bash
+pip install django-sastry
+```
+
+Or install directly from GitHub:
+
+```bash
+pip install git+https://github.com/globalkrishna/django-sastry.git
+```
+
+---
+
+## Quickstart
+
+### 1. Add to `INSTALLED_APPS`
+
+In your Django `settings.py`:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "sastry",
+]
+```
+
+### 2. Configure Jinja2 Templates
+
+In your Django `settings.py`:
+
+```python
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.jinja2.Jinja2",
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "environment": "config.jinja2.environment",
+        },
+    },
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "APP_DIRS": True,
+        # ...
+    },
+]
+```
+
+Define the standard environment helper in `config/jinja2.py`:
+
+```python
+from jinja2 import Environment
+from django.templatetags.static import static
+from django.urls import reverse
+
+def environment(**options):
+    env = Environment(**options)
+    env.globals.update({"static": static, "url": reverse})
+    return env
+```
+
+### 3. Include URLs
+
+In your project's root `urls.py`:
+
+```python
+from django.urls import path, include
+
+urlpatterns = [
+    # ...
+    path("sastry/", include("sastry.urls")),
+]
+```
+
+### 4. Collect Static Assets
+
+```bash
+python manage.py collectstatic --noinput
+```
+
+### 5. Access the Interfaces
+
+Start your development server:
+
+```bash
+python manage.py runserver
+```
+
+- **Visual ER Diagram**: Navigate to `http://127.0.0.1:8000/sastry/er/`
+- **Dynamic CRUD Grid**: Navigate to `http://127.0.0.1:8000/sastry/`
+
+---
+
+## Security & Permissions
+
+Access to `/sastry/` and `/sastry/er/` requires standard administrator authentication:
+- `request.user.is_superuser` or `request.user.is_admin` must evaluate to `True`.
+- Non-administrators receive an HTTP 403 Forbidden response.
+
+---
+
+## License
+
+MIT License. Developed by Krishnamurthy (Global Multimedia).
+Contributions and feature suggestions are welcome!
+

django_sastry-1.0.0/README.md

@@ -0,0 +1,233 @@
+# Django Sastry (django-sastry)
+
+[![CI](https://github.com/globalkrishna/django-sastry/actions/workflows/ci.yml/badge.svg)](https://github.com/globalkrishna/django-sastry/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Python Versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/)
+[![Django Versions](https://img.shields.io/badge/django-4.2%20%7C%205.0%20%7C%205.1-green)](https://www.djangoproject.com/)
+
+A lightweight, zero-configuration dynamic CRUD administration interface and interactive visual **Entity Relations (ER) Diagram** engine for Django.
+
+<p align="center">
+  <img src="docs/images/er_diagram_preview.png" alt="Django Sastry Interactive ER Diagram" width="900" style="border-radius: 8px; box-shadow: 0 4px 12px rgba(0,0,0,0.15);" />
+</p>
+
+---
+
+## Highlights & Features
+
+1. **Interactive Visual Entity Relations (ER) Diagram**:
+   - **Right-Anchored Selected Model**: The active selected table is anchored to the extreme right, directly adjacent to the field inspector panel, with incoming reverse relations (`has_many` / child tables in cyan) and outgoing foreign key targets (in warm tones) plotted across vertical columns to the left.
+   - **Reactive Schema Navigation**: Click any table card or foreign key to immediately make it the active model and move it to the right, refreshing all its upstream and downstream relations.
+   - **Multi-Column Bin-Packing**: Automatically distributes child and referenced tables across vertical columns to the left to prevent tall single-column spillover for heavily connected models.
+   - **Vector Connection Canvas**: Color-coded relational links with directional arrowheads for child table reverse relations and circular anchor nodes for foreign key targets.
+   - **Field-Level Inspector**: Click any field in the active table to view its verbose name, Django internal type, nullability, blankness, uniqueness, database indexes, and reverse references.
+
+2. **Zero-Config Dynamic CRUD**:
+   - Instant spreadsheet-style data grid for all registered Django models without requiring boilerplate `admin.py` registrations.
+   - Paginated browsing, multi-field filtering, search, and inline record creation/editing.
+   - Safe foreign key resolution with query limits preventing unbounded database loads.
+
+3. **Modular ERP Application Foundation**:
+   - Extensible base template hierarchy (`saz3.html` -> `saz3Nav.html` -> `s_home.html`) powering enterprise suites (such as `erp.saas3.in`).
+   - Easily inject custom modules into the navigation bar (Orders, Customer, Inventory, BOM, Sales, Billing).
+   - Reusable `getData` / `mdlData` backend pipelines and subclassable frontend controllers (`class CustomerController extends db_crud`) with custom action triggers (like `#ShowExtraDetail` for Orders).
+
+4. **Lightweight & Non-Intrusive**:
+   - Introspects model structure using Django's native `Model._meta` APIs in memory with zero database queries during diagram generation.
+   - Zero external frontend dependencies: built with modern vanilla ES6 JavaScript and HTML5 Canvas.
+
+---
+
+## The Core Philosophy: The 90/10 Architecture of Database Applications
+
+> *"Most database applications center around selecting some filtered rows, and selecting one of them to view details in a custom way."*
+
+In traditional enterprise software development, building any new module (such as Customer Management, Job Cards, or Fabric Inventory) requires writing substantial boilerplate: API endpoints, pagination, multi-column search, filter drawers, sorting SQL, table HTML, form builders, and relational bindings. This mundane plumbing consumes **80% to 90%** of development time.
+
+**`django-sastry` solves this by inverting the pyramid:**
+- **The 90% (Out-of-the-Box)**: Sastry automatically provides the high-performance relational data grid, instant dynamic search, multi-field filtering, pagination, inline modal editing, and visual ER schema diagram.
+- **The 10% (Your Custom View)**: You only write the domain-specific detail view (an itemized order dossier, a bespoke canvas designer, or a retail invoice).
+
+### The Pattern in Action: A Complete Application in ~40 Lines
+
+#### 1. Backend: Thin View with `getData` (`views.py`)
+```python
+@login_required
+def CustomersList(request, ctyp=0):
+    dat = json.loads(request.GET.get("dat", "{}"))
+    types = CustomerType.objects.all().order_by("name").values_list("id", "name")
+    if not ctyp and types:
+        ctyp = types[0][0]
+    if "filter" not in dat:
+        dat["filter"] = {"customer_type_id": ctyp}
+    dat["show"] = ["id", "customer_id", "name", "city", "state_id"]
+    
+    # Sastry handles the complete query, pagination, sorting, and serialization:
+    data = getData("customer", "Customer", dat)
+    data["ctype"] = types
+    return render(request, "CustomerPage.html", data)
+```
+
+#### 2. Frontend: Subclassing `db_crud` (`customer.ts`)
+```typescript
+import { db_crud } from '/static/sastry/js/s_crud.js';
+
+class CustomerListController extends db_crud<Customer> {
+    constructor() {
+        super();
+        this.setData();
+        // Hook custom filter buttons (e.g. Retail, Wholesale, Distributor)
+        document.querySelectorAll('#FilterType a').forEach(el => {
+            el.onclick = (e) => this.filterByType(e);
+        });
+        // Enable Sastry's built-in toolbar action button for drill-down
+        const extraBtn = document.getElementById("ShowExtraDetail");
+        extraBtn.textContent = "Orders";
+        extraBtn.classList.remove('d-none');
+    }
+
+    ShowTab(tab: string) {
+        super.ShowTab(tab);
+        if (tab !== 'ExtraDetail') return;
+
+        // Retrieve selected row from Sastry's active table
+        const indexRow = document.querySelector('#index tbody tr.table-active') as HTMLTableRowElement;
+        const customer = this.collection[indexRow.rowIndex - 1];
+
+        // Fetch and display the custom detail view for this customer:
+        fetch(`/customer/cust_order/${customer.id}/`)
+            .then(res => res.text())
+            .then(html => {
+                document.getElementById('ExtraDetail')!.innerHTML = html;
+                document.querySelector("#ExtraDetail #Bak2index")!.onclick = () => this.ShowTab('index');
+            });
+    }
+}
+```
+
+By simply writing the custom detail view and connecting it via Sastry's extension points, you achieve a **production-ready, enterprise-grade application** in a few hours.
+
+---
+
+## Documentation & User Manual
+
+For an in-depth walkthrough of the system, including visual diagrams, color specifications, and step-by-step guides for extending Sastry into a custom ERP application, see the official manual:
+
+👉 **[Comprehensive User Manual & ERP Extensibility Guide (docs/USER_MANUAL.md)](docs/USER_MANUAL.md)**
+
+### Manual Highlights:
+- **[Interactive Visual ER Diagram Guide](docs/USER_MANUAL.md#3-interactive-visual-er-diagram)**: Details on the right-anchored model layout, right-to-left multi-column bin packing, color conventions (Gold, Cyan, Amber), and reactive table-clicking.
+- **[Dynamic CRUD Data Grid Guide](docs/USER_MANUAL.md#4-dynamic-crud-data-grid)**: Filtering, sorting, pagination, inline edits, and foreign key optimization.
+- **[ERP Extensibility Guide](docs/USER_MANUAL.md#5-erp-extensibility-guide-the-erpsaas3in-architecture)**: How to hook custom pages from the index navbar (`s_home.html`), author custom views reusing `getData`, build offcanvas filter drawers (`FilterType`), and subclass `db_crud` to display custom buttons like `[⤢ Orders]`.
+- **[Python & JavaScript API Reference](docs/USER_MANUAL.md#7-api-reference)**: Complete function signatures and class definitions.
+
+---
+
+## Installation
+
+Install via pip:
+
+```bash
+pip install django-sastry
+```
+
+Or install directly from GitHub:
+
+```bash
+pip install git+https://github.com/globalkrishna/django-sastry.git
+```
+
+---
+
+## Quickstart
+
+### 1. Add to `INSTALLED_APPS`
+
+In your Django `settings.py`:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "sastry",
+]
+```
+
+### 2. Configure Jinja2 Templates
+
+In your Django `settings.py`:
+
+```python
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.jinja2.Jinja2",
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "environment": "config.jinja2.environment",
+        },
+    },
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "APP_DIRS": True,
+        # ...
+    },
+]
+```
+
+Define the standard environment helper in `config/jinja2.py`:
+
+```python
+from jinja2 import Environment
+from django.templatetags.static import static
+from django.urls import reverse
+
+def environment(**options):
+    env = Environment(**options)
+    env.globals.update({"static": static, "url": reverse})
+    return env
+```
+
+### 3. Include URLs
+
+In your project's root `urls.py`:
+
+```python
+from django.urls import path, include
+
+urlpatterns = [
+    # ...
+    path("sastry/", include("sastry.urls")),
+]
+```
+
+### 4. Collect Static Assets
+
+```bash
+python manage.py collectstatic --noinput
+```
+
+### 5. Access the Interfaces
+
+Start your development server:
+
+```bash
+python manage.py runserver
+```
+
+- **Visual ER Diagram**: Navigate to `http://127.0.0.1:8000/sastry/er/`
+- **Dynamic CRUD Grid**: Navigate to `http://127.0.0.1:8000/sastry/`
+
+---
+
+## Security & Permissions
+
+Access to `/sastry/` and `/sastry/er/` requires standard administrator authentication:
+- `request.user.is_superuser` or `request.user.is_admin` must evaluate to `True`.
+- Non-administrators receive an HTTP 403 Forbidden response.
+
+---
+
+## License
+
+MIT License. Developed by Krishnamurthy (Global Multimedia).
+Contributions and feature suggestions are welcome!
+