{
"info": {
"author": "Cesar Abel Ramirez",
"author_email": "xangcastle@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 5 - Production/Stable",
"Environment :: Web Environment",
"Framework :: Django",
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Topic :: Software Development :: Libraries",
"Topic :: Utilities"
],
"description": "# grappelli_extras\n\n[](https://crate.io/packages/django-grappelli-extras/)\n\n[](https://crate.io/packages/django-grappelli-extras/)\n\n# Requirements\n* Python = 3\n* Django >= 2.1\n* django-grappelli >= 2.11.1\n\n# Installation\n\n* ```pip install django-grappelli-extras```\n\n## settings.py\n\n * Put 'grappelli_extras' **before** 'grappelli' on INSTALLED_APPS\n\n```python\n# Your setting will look like:\nINSTALLED_APPS = [\n 'grappelli_extras',\n 'grappelli',\n 'import_export',\n 'adminactions',\n 'django.contrib.admin',\n 'django.contrib.auth',\n 'django.contrib.contenttypes',\n 'django.contrib.sessions',\n 'django.contrib.messages',\n 'django.contrib.staticfiles',\n # continue with your apps\n]\n```\n\n* Put 'applist' in your active context_processors.\n```python\nTEMPLATES = [\n {\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\n 'DIRS': [],\n 'APP_DIRS': True,\n 'OPTIONS': {\n 'context_processors': [\n 'django.template.context_processors.debug',\n 'django.template.context_processors.request',\n 'django.contrib.auth.context_processors.auth',\n 'django.contrib.messages.context_processors.messages',\n 'grappelli_extras.context_processors.applist',\n \n # if you need to add customs menu\n 'grappelli_extras.context_processors.extra_menus',\n ],\n },\n },\n]\n```\n\n\nTo configure the extra menus than you need please add the following config\nyour settings:\n\n```python\nEXTRA_MENUS = [\n {'menu': 'Reports', 'link': '#',\n\n 'options': [\n {'link': '/reports/report1', 'label': 'Report # 1',\n 'perm': 'app.can_report_1'},\n {'link': '/reports/report2', 'label': 'Report # 2',\n 'perm': 'app.can_report_2'},\n ]\n\n },\n]\n```\n\n\n\n## urls.py\n\n * Put grappelli extras urls in 'urlpatterns':\n\n```python\n# Your urls will look like:\nfrom django.contrib import admin\nfrom django.urls import path, include\n\nurlpatterns = [\n path('admin/', admin.site.urls),\n path('grappelli/', include('grappelli.urls')),\n path('admin/ajax/', include('grappelli_extras.ajax_urls')),\n path('admin/extras/', include('grappelli_extras.extras_urls')),\n]\n```\n\n\nAvailable features:\n\n* [Header navbar](#navbar)\nAdd a dynamic navbar that change according to user permissions\n\n* [Add Links](#add-links)\nAdd addlink for each model in the nabvar according to user permissions.\n\n* [Traslation](#translation)\nTraslation Suport by Locales.\n\n* [Ajax](#ajax)\nAn Ajax api to make queries to django OMR using generics views.\nThe ajax url list are:\n\n * \"{% url 'ajax_getCollection' %}\"\n * \"{% url 'ajax_getObject' %}\"\n * \"{% url 'ajax_autocomplete' %}\"\n \nBut if you need to use in a javascript file out of a django template, you can use as:\n\n * $ajax_getColletion\n * $ajax_getObject\n * $ajax_autocomplete\n\nThis is the way than you must to define your models\nthe class base from grappelli_extras contain important functions for the models\n\n```python\nfrom django.db import models\nfrom grappelli_extras.models import base, BaseEntity\nfrom django.template.loader import render_to_string\n\n\nclass Foo(BaseEntity):\n \"\"\"\n A usual model than requiere to have a code, name and active condition.\n This the code left in blank under the creation of the object the code will be autogerenate.\n\n \"\"\"\n date = models.DateTimeField()\n title = models.CharField(max_length=250)\n description = models.TextField(max_length=600, null=True, blank=True)\n\n def render_as_table(self):\n return render_to_string(\"app/foo.html\", {'obj': self})\n\n\nclass Bar(base):\n \"\"\"\n A usual related model for Foo\n \"\"\"\n foo = models.ForeignKey(Foo, on_delete=models.CASCADE)\n value = models.FloatField(default=0.0)\n \n\n```\n\n\n# Using Autocomplete generic view\n```html\n\n\n\n\n\n```\n\n# Using GetCollection generic view\n```html\n\n\n\n```\n\n# Using GetObject generic view\n```html\n\n\n\n```\n\n# Using ObjectView generic view\nFirst define the method returning a html string\n```python\nfrom grappelli_extras.models import BaseEntity\nfrom django.template.loader import render_to_string\n\nclass Foo(BaseEntity):\n ...\n def render_as_table(self):\n return render_to_string(\"app/foo.html\", {'obj': self})\n\n```\n\nIn the html template render using django tags and filters as usual\n```djangotemplate\n
\n \n
\n
Foo Object
\n
\n
\n
Key
\n
Value
\n
\n \n\n \n
\n
ID
\n
{{obj.id}}
\n
\n
\n
CODE
\n
{{obj.code}}
\n
\n
\n
NAME
\n
{{obj.name}}
\n
\n \n
\n\n```\nAfter when you need to render this conten by Ajax\n```html\n\n\n\n\n\n```\n\n# Working with jQuery pluggins.\nLet start with datatables.\n\nIn your template include the js script ajax token.js after jQuery to keep secure the request.\nAnd include all css and js as you need.\n\n```djangotemplate\n\n\n\n \n Title\n\n\n{% load static %}\n\n