add toolbar feature. override Index.html so as to better integrate wi…

…th DjangoCMS

README.md

@@ -12,42 +12,55 @@ Add the following to `INSTALLED_APPS` in `settings.py`
 		'django_version_viewer'
 	]
 
-Add `django_version_viewer` include to `urls.py`
+## Add django_version_viewer urls and extend `admin/index.html`
+
+
+Django Version Viewer needs to extend the `admin/index.html` and append it's urls to your `urls.py`. In your `urls.py` add:
+
+	admin.site.index_template = 'admin/custom_index.html'
+	admin.autodiscover()
 
 	urlpatterns = [
 		...
 		url(r'^django_version_viewer/', include('django_version_viewer.urls')),
 		...
 	]
 
-You can set your own access permissions on the template tag and route by defining your own
-`Accessor` class. This class must have a `allow_access` method that returns a `boolean`. By defualt,
-django_version_viewer only allows superusers access to the route and template tag.
+In your `templates` dir, create a `custom_index.html`.
 
-	# Django Version Viewer settings:
-	# default class only allows superusers access
-	ACCESSOR_CLASS_PATH = 'mypathto.my.AccessorClass'
+	<!-- custom_index.html -->
+	{% extends "admin/index.html" %}
 
+	{% load i18n admin_static pip_version_viewer_tags %}
 
-## Your Project is NOT using DjangoCMS
+	{% block content %}
+	{% show_pip_package_versions %}
+	{{ block.super }}
+	{% endblock %}
 
-Override the `base_site.html` django Admin template (or the template of your choosing) by creating a `base.html` file  inside a `templates/admin` directory in your project (Refer to the example project's
-`base_site_regular.html`).
 
-Make sure you insert the necessary `src` and `link` blocks so that the popup modal works properly.
+	<!-- only add this if you are NOT using djangoCMS -->
+	{% block extrahead %}
+		<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
+		<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.0/jquery.min.js"></script>
+		<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
+	{% endblock %}
 
+If you are using DjangoCMS the added style sheet and js might interfere with DjangoCMS's styling. In this case you should
+create a file called `admin/inc/userlinks.html` inside your `templates` directory.
+
+	<!-- userlinks.html -->
 	<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
 	<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.0/jquery.min.js"></script>
 	<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
 
-Finally, load the template tags file and insert the template tag where ever you want the "Installed Versions" link to show up:
-
-    {% load pip_version_viewer_tags %}
-    {% show_pip_package_versions %}
 
-## Your Project IS using DjangoCMS
+## Permissions
 
-Override the `base_site.html` django Admin template (or the template of your choosing) by creating a `base.html` file  inside a `templates/admin` directory in your project (Refer to the example project's
-`base_site.html`. This file is based off of DjangoCMS's `base_site.html` file).
+You can set your own access permissions on the template tag and route by defining your own
+`Accessor` class. This class must have a `allow_access` method that returns a `boolean`. By defualt,
+django_version_viewer only allows superusers access to the route and template tag.
 
-Make sure you insert the necessary `src` and `link` blocks inside `admin/inc/userlinks.html`so that the popup modal works properly.
+	# Django Version Viewer settings:
+	# default class only allows superusers access
+	ACCESSOR_CLASS_PATH = 'mypathto.my.AccessorClass'

django_version_viewer/cms_toolbars.py

@@ -0,0 +1,32 @@
+from django.core.urlresolvers import reverse
+from django.conf import settings
+from django.utils.translation import ugettext_lazy as _
+
+from cms.api import get_page_draft
+from cms.toolbar_pool import toolbar_pool
+from cms.toolbar_base import CMSToolbar
+
+from pydoc import locate
+
+accessor_class = locate(
+    getattr(settings, 'ACCESSOR_CLASS_PATH', 'django_version_viewer.mixins.Accessor'))
+accessor = accessor_class()
+
+
+@toolbar_pool.register
+class DjangoViewerToolbar(CMSToolbar):
+    def populate(self):
+        # always use draft if we have a page
+        self.page = get_page_draft(self.request.current_page)
+
+        if not self.page:
+            return
+
+        disabled = not accessor.allow_access(self.request)
+        current_page_menu = self.toolbar.get_or_create_menu('page')
+
+        current_page_menu.add_modal_item(
+            _('View Pip Packages'),
+            url=reverse('django_version_viewer_toolbar'),
+            disabled=disabled
+        )

django_version_viewer/templates/test.html → django_version_viewer/templates/toolbar.html

@@ -1,6 +1,6 @@
+{% extends "admin/base_site.html" %}
 
-
-<!-- {% block content %}
+{% block content %}
 {% if success %}
     {% comment %}
         Need to use js reload since Django doesn't provide a good
@@ -23,4 +23,4 @@ <h4 class="modal-title">Versions</h4>
 
       </div>
 </div>
-{% endblock %} -->
+{% endblock %}

django_version_viewer/urls.py

@@ -10,5 +10,5 @@
 urlpatterns = [
     url(r'^$', views.DjangoVersionViewer.as_view(), name='django_version_viewer'),
     url(r'^csv/$', views.DjangoVersionViewerCSV.as_view(), name='django_version_viewer_csv'),
-    # url(r'^toolbar/$', views.DjangoVersionViewerToolBar.as_view(), name='django_version_viewer_toolbar'),
+    url(r'^toolbar/$', views.DjangoVersionViewerToolBar.as_view(), name='django_version_viewer_toolbar'),
 ]

django_version_viewer/views.py

@@ -18,7 +18,7 @@
 
 
 class DjangoVersionViewerToolBar(TemplateView):
-    template_name = "test.html"
+    template_name = "toolbar.html"
 
     def get_context_data(self, **kwargs):
         context = super(DjangoVersionViewerToolBar, self).get_context_data(**kwargs)

example18/example18/urls.py

@@ -15,6 +15,10 @@
 from django.conf.urls import include, url
 from django.contrib import admin
 
+admin.site.index_template = 'admin/custom_index.html'
+admin.autodiscover()
+
+
 urlpatterns = [
     url(r'^admin/', include(admin.site.urls)),
     url(r'^django_version_viewer/', include('django_version_viewer.urls')),

example18/templates/admin/custom_index.html

@@ -0,0 +1,8 @@
+{% extends "admin/index.html" %}
+
+{% load i18n admin_static pip_version_viewer_tags %}
+
+{% block content %}
+{% show_pip_package_versions %}
+{{ block.super }}
+{% endblock %}