Installation

You need Python 3.6 or higher and Django 2.1 or higher.

Install:

pip install Djaq

The bleeding edge experience:

pip install https://github.com/paul-wolf/djaq/archive/master.zip

Now you can call the Djaq API:

from djaq import DjaqQuery as DQ

print(list(DQ("Book", "name as title, publisher.name as publisher").dicts()))

[{'title': 'Name grow along.', 'publisher': 'Long, Lewis and Wright'}, {'title': 'We pay single record.', 'publisher':\
'Long, Lewis and Wright'}, {'title': 'Natural develop available manager.', 'publisher': 'Long, Lewis and Wright'}, {'\
title': 'Fight task international.', 'publisher': 'Long, Lewis and Wright'}, {'title': 'Discover floor phone.', 'publi\
sher': 'Long, Lewis and Wright'}]

Providing a Remote API

We’ll assume below you are installing the Djaq UI. This is not required to provide an API but is useful to try things out.

Install the API and UI in settings:

INSTALLED_APPS = (
    '...',
    djaq.djaq_api,
    djaq.djaq_ui,
)

Configure urls in urls.py:

urlpatterns = [
    '...',
    path("dquery/", include("djaq.djaq_ui.urls")),
    path("djaq/", include("djaq.djaq_api.urls")),
]

You are done. You can start sending requests to:

/djaq/api/request/

The UI will be available at:

/dquery

Note the UI will send requests to the API endpoint so will not work without that being configured. You send a request in this form to the api endpoint:

{
    "queries": [
        {
            "model": "books.Book",
            "output": "id,\nname,\npages,\nprice,\nrating,\npublisher,\nalt_publisher,\npubdate,\nin_print,\n",
            "where": "",
            "order_by": "",
            "limit": "100",
            "offset": "0"
        }
    ]
}

The UI will create this JSON for you if you want to avoid typing it.

You can also create objects, update them and delete them:

{
    "queries": [
        {
            "model": "books.Book",
            "output": "id,\nname,\npages,\nprice,\nrating,\npublisher,\nalt_publisher,\npubdate,\nin_print,\n",
            "where": "",
            "order_by": "",
            "limit": "100",
            "offset": "0"
        }
    ],
    "creates": [
        {
            "model": "Book",
            "fields": {
                "name": "my new book"
            }
        }
    ],
    "updates": [
        {
            "model": "Book",
            "pk": 37,
            "fields": {
                "name": "my new title"
            }
        }
    ],
    "deletes": [
        {
            "model": "Book",
            "pk": 37
        }
    ]
}

You can send multiple queries, creates, updates, deletes operations in a single request.