Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/django-dynamic-datatb
Django Dynamic Datatables - Open-Source Library | AppSeed
https://github.com/app-generator/django-dynamic-datatb
datatable datatable-django datatable-dynamic datatable-generator datatables datatables-serverside django django-and-datatables django-datatables django-generator django-tables dynamic-programming free-django-sample generator-dt open-source pypi-package
Last synced: 2 days ago
JSON representation
Django Dynamic Datatables - Open-Source Library | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/django-dynamic-datatb
- Owner: app-generator
- License: mit
- Created: 2022-10-30T05:26:03.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-17T04:46:12.000Z (3 months ago)
- Last Synced: 2024-12-22T11:08:14.676Z (9 days ago)
- Topics: datatable, datatable-django, datatable-dynamic, datatable-generator, datatables, datatables-serverside, django, django-and-datatables, django-datatables, django-generator, django-tables, dynamic-programming, free-django-sample, generator-dt, open-source, pypi-package
- Language: JavaScript
- Homepage: https://app-generator.dev/docs/developer-tools/dynamic-datatables.html
- Size: 93.8 KB
- Stars: 45
- Watchers: 5
- Forks: 20
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Django Dynamic DataTables](https://app-generator.dev/docs/developer-tools/dynamic-datatables.html)
`Open-Source` library for **Django** that provides a `powerful data table interface` (paginated information) with minimum effort - actively supported by **[App-Generator](https://app-generator.dev/)**.
- [Django Dynamic DataTables](https://www.youtube.com/watch?v=EtMCK5AmdQI) - video presentation
---
> For a **complete set of features** and long-term support, check out **[Dynamic Django](https://app-generator.dev/docs/developer-tools/dynamic-django/index.html)**, a powerful starter that incorporates:
- [Dynamic DataTables](https://app-generator.dev/docs/developer-tools/dynamic-django/datatables.html): using a single line of configuration, the data saved in any table is automatically managed
- [Dynamic API](https://app-generator.dev/docs/developer-tools/dynamic-django/api.html): any model can become a secure API Endpoint using DRF
- [Dynamic Charts](https://app-generator.dev/docs/developer-tools/dynamic-django/charts.html): extract relevant charts without coding all major types are supported
- [CSV Loader](https://app-generator.dev/docs/developer-tools/dynamic-django/csv-loader.html): translate CSV files into Django Models and (optional) load the information
- Powerful [CLI Tools](https://app-generator.dev/docs/developer-tools/dynamic-django/cli.html) for the GIT interface, configuration editing, updating the configuration and database (create models, migrate DB)
> Features
- Modern Stack: `Django` & `VanillaJS`
- `DT` layer provided by [Simple-DataTables](https://github.com/fiduswriter/Simple-DataTables)
- `Server-side` pagination
- Search, Filters
- Exports in PDF, CSV formats
- `MIT License` (commercial use allowed)
## How to use it
> **Step #1** - `Install the package`
```bash
$ pip install django-dynamic-datatb
// OR
$ pip install git+https://github.com/app-generator/django-dynamic-datatb.git
```
> **Step #2** - Update Configuration, `add new imports`
```python
import os, inspect
import django_dyn_dt
```
> **Step #3** - Update Configuration, `include the new APPs`
```python
INSTALLED_APPS = [
'django_dyn_dt', # <-- NEW App
]
```
> **Step #4** - Update Configuration, include the new `TEMPLATES` DIR
```python
TEMPLATE_DIR_DATATB = os.path.join(BASE_DIR, "django_dyn_dt/templates") # <-- NEW App
TEMPLATES = [
{
"BACKEND": "django.template.backends.django.DjangoTemplates",
"DIRS": [TEMPLATE_DIR_DATATB], # <-- NEW Include
"APP_DIRS": True,
"OPTIONS": {
},
},
]
```
> **Step #5** - Update Configuration, update `STATICFILES_DIRS` DIR
```python
DYN_DB_PKG_ROOT = os.path.dirname( inspect.getfile( django_dyn_dt ) ) # <-- NEW App
STATICFILES_DIRS = (
os.path.join(DYN_DB_PKG_ROOT, "templates/static"),
)
```
> **Step #6** - `Register the model` in `settings.py` (DYNAMIC_DATATB 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",
}
```
> **Step #7** - `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
]
```
> **Step #8** - Use the Dynamic Datatable module
If the managed model is `Books`, the dynamic interface is `/datatb/books/` and all features available.
### 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`
---
[Django Dynamic DataTables](https://app-generator.dev/docs/developer-tools/dynamic-datatables.html) - Open-source library provided by **[App-Generator](https://app-generator.dev/)**