Release v0.0.1 - Initial Version

Author: app-generator

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Change Log
+
+## [0.0.1] 2022-10-30
+### Initial Version
+
+- Codebase design

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 [App Generator](https://appseed.us)
+
+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.

MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE.md
+include README.md
+recursive-include django_dyn_tb *
+recursive-include docs *

README.md

@@ -1 +1,100 @@
-# django-dynamic-datatb
+# [Django Dynamic DataTables](https://github.com/app-generator/django-dynamic-datatb)
+
+Simple tool that **Generates Secure APIs** on top of `DRF` with minimum effort - actively supported by [AppSeed](https://appseed.us/).
+
+<br />
+
+> Features
+
+- `DataTables` provided by `Simple DataTables`
+- `Minimal Configuration` (single line in config for each model)
+- `Handles any model` defined across the project
+
+<br />
+
+![Django Dynamic API - DRF Interface (open-source tool).](https://user-images.githubusercontent.com/51070104/197181145-f7458df7-23c3-4c14-bcb1-8e168882a104.jpg)
+
+<br />
+
+## How to use it
+
+<br />
+
+> **Step #1** - `Install the package` 
+
+```bash
+$ pip install django-dynamic-datatb
+// OR
+$ pip install git+https://github.com/app-generator/django-dynamic-datatb.git
+```
+
+<br />
+
+> **Step #2** - `Update Configuration`, include the new APPs
+
+```python
+INSTALLED_APPS = [
+    'django_dyn_dt',    # Django Dynamic Data tables  # <-- NEW
+]
+```
+
+<br />
+
+> **Step #3** - `Register the model` in `core/settings.py` (DYNAMIC_API section)
+
+This sample code assumes that `app1` exists and model `Book` is defined and migrated.
+
+```python
+
+DYNAMIC_DATATB = {
+    # SLUG -> Import_PATH 
+    'books'  : "app1.models.Book",
+}
+
+```
+
+<br />
+
+> **Step #4** - `Migrate DB`
+
+```bash
+$ python manage.py makemigrations
+$ python manage.py migrate
+```
+
+<br />
+
+> **Step #5** - `Update routing`, include APIs 
+
+```python
+from django.contrib import admin
+from django.urls import path, include         # <-- NEW: 'include` directive added
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+    path('', include('django_dyn_dt.urls')),  # <-- NEW: API routing rules
+]    
+```    
+
+<br />
+
+> **Step #7** - Use the Dynamic Datatable module 
+
+If the managed model is `Books`, the dynamic interface is `/datatb/books/` and all features available. 
+
+<br />
+
+![Django API Generator - POSTMAN Interface (open-source tool).](https://user-images.githubusercontent.com/51070104/197181265-eb648e27-e5cf-4f3c-b330-d000aba53c6a.jpg)
+
+<br />
+
+### Links & resources 
+
+- [DRF](https://www.django-rest-framework.org/) - HOMEpage
+- More [Developer Tools](https://appseed.us/developer-tools/) provided by `AppSeed`
+- Ask for [Support](https://appseed.us/support/) via `Email` & `Discord` 
+
+<br />
+
+---
+[Django Dynamic DataTables](https://github.com/app-generator/django-dynamic-datatb) - Open-source library provided by **[AppSeed](https://appseed.us/)**

django_dyn_dt/__init__.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

django_dyn_dt/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class DynDatatablesConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'apps.dyn_datatables'

django_dyn_dt/apps.py

@@ -0,0 +1,67 @@
+# -*- encoding: utf-8 -*-
+"""
+Copyright (c) 2019 - present AppSeed.us
+"""
+
+import datetime, sys, inspect, importlib
+
+from functools import wraps
+
+
+from django.db import models
+from rest_framework import serializers
+
+from functools import wraps
+
+from django.http import HttpResponseRedirect, HttpResponse
+
+class Utils:
+    @staticmethod
+    def get_class(config, name: str) -> models.Model:
+        return Utils.model_name_to_class(config[name])
+
+    @staticmethod
+    def get_manager(config, name: str) -> models.Manager:
+        return Utils.get_class(config, name).objects
+
+    @staticmethod
+    def get_serializer(config, name: str):
+        class Serializer(serializers.ModelSerializer):
+            class Meta:
+                model = Utils.get_class(config, name)
+                fields = '__all__'
+
+        return Serializer
+
+    @staticmethod
+    def model_name_to_class(name: str):
+
+        model_name    = name.split('.')[-1]
+        model_import  = name.replace('.'+model_name, '') 
+
+        module = importlib.import_module(model_import)
+        cls = getattr(module, model_name)
+
+        return cls 
+
+def check_permission(function):
+    @wraps(function)
+    def wrap(viewRequest, *args, **kwargs):
+
+        try:
+
+            # Check user
+            if viewRequest.request.user.is_authenticated:
+                return function(viewRequest, *args, **kwargs)
+
+            # All good - allow the processing
+            return HttpResponseRedirect('/login/')
+
+        except Exception as e:
+
+            # On error
+            return HttpResponse( 'Error: ' + str( e ) )
+
+        return function(viewRequest, *args, **kwargs)
+
+    return wrap

django_dyn_dt/helpers.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

django_dyn_dt/models.py

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>404 not found</title>
+
+    <!-- bootstrap5 -->
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script>
+
+</head>
+<body>
+    <div class="d-flex flex-column text-center vh-100 justify-content-center">
+        <h1 class="fw-bolder display-1">404</h1>
+        <h3>
+            page not found!
+        </h3>
+    </div>
+</body>
+</html>