forked from versae/qbe
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
88 lines (52 loc) · 2.44 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
Django Query by Example (QBE)
=============================
:synopsis: Admin tool in order to get custom reports.
The objective of django-qbe is provide a assited and interactive way of making
complex queries with no technical knowledge (or minimal) to get custom reports
from the objects of Django models.
Based on QBE_ proposal from IBM®, django-qbe is intended to remove the
limitations of Django QuerySets objects and to use the whole expresive power of
the subjacent SQL.
Installation
------------
Using the Python Package Index (PyPI_) and easy_install script::
$ easy_install django_qbe
Or through pip::
$ pip install django_qbe
But you also can download the *django_qbe* directory using git::
$ git clone git://github.com/versae/qbe.git
$ cp -r qbe/django_qbe /path/to/your/project
Adding to the project settings::
INSTALLED_APPS = (
# [...] django builtins applications
'django_qbe',
# [...] Any other application
)
And adding the urlconf in your project urls.py::
# qbe
url(r'^qbe/', include('django_qbe.urls')),
You must not forgive link or copy the *django_qbe/media/django_qbe*
directory in your project media directory::
$ ln -s django_qbe/media/django_qbe /path/to/your/project/media/
That's all. Then you can access to http://host:port/qbe
However, you can add a link from your admin page changing the admin index
template fo your AdminSite::
class AdminSite(admin.AdminSite):
index_template = "qbe_index.html"
Or adding in your custom admin index template the next javascript::
<script type="text/javascript" src="{% url qbe_js %}"></script>
Settings
--------
The next lines show de available settings and its default values.
Enable autocompletion tool (work in progress, not enabled yet)::
QBE_AUTOCOMPLETE = True
Enable an Exhibit faceted navigation for results (not yet implemented)::
QBE_EXHIBIT = False
Admin module name to add admin urls in results::
QBE_ADMIN = "admin"
Function to control to users with access to QBE::
QBE_ACCESS_FOR = lambda user: user.is_staff
Path to QBE formats export file, in order to add custom export formats::
QBE_FORMATS_EXPORT = "qbe_formats"
.. _QBE: http://www.google.com/url?sa=t&source=web&ct=res&cd=2&ved=0CB4QFjAB&url=http%3A%2F%2Fpages.cs.wisc.edu%2F~dbbook%2FopenAccess%2FthirdEdition%2Fqbe.pdf&ei=_UD5S5WSBYP5-Qb-18i8CA&usg=AFQjCNHMv-Pua285zhWT8DevuZFj2gfYKA&sig2=-sTEDWjJhnTaixh2iJfsAw
.. _PyPI: http://pypi.python.org/pypi/django_qbe/0.1.0