A non-relational Django database backend that utilizes EnterpriseWizard's REST interface.
Project description
- Version:
- 1.5.1
- Dependencies:
Python 3.4+, Django>=1.5, djangotoolbox>=1.6.2, requests>=2.2.0
- Home page:
- License:
GNU LGPL (http://www.gnu.org/licenses/lgpl.html)
NOTE: Versions 1.3+ will work with the EnterpriseWizard anti-sql block. In order to achieve this, regular expression and case-insensitive query operations were removed.
Installation
Run pip install django-ewiz
Add django_ewiz to INSTALLED_APPS
INSTALLED_APPS = (
...
'django_ewiz',
...
)Usage
Basic Usage
In the DATABASES settings dictionary, simply use django_ewiz as the ENGINE key.
'default': {
'ENGINE': 'django_ewiz',
'NAME': '', # The name of the knowlegebase
'USER': '', # The name of the user
'PASSWORD': '', # The user's password
'HOST': '', # EnterpriseWizard's REST base url, generally 'www.example.com/ewws/'. Don't include the protocol string (e.g. 'http://').
'PORT': '', # Either 80 or 443 (HTTP or HTTPS requests only)
'NUM_CONNECTIONS': '', # Default: 1, Allows multiple concurrent connections to be used when retrieving multiple tickets in a query.
},That’s it! All database operations performed will be abstracted and should function as the usual engines do (unless what you wish to do conflicts with the options below).
The following query operations are supported:
iexact
icontains
in
gt
gte
lt
lte
istartswith
iendswith
range
year
isnull
The following query operations will be converted to their respective case-insensitive forms: (version 1.3+)
exact
contains
startswith
endswith
The following query operations are no longer supported: (version 1.3+)
regex
iregex
NOTE: Not all ticket fields can be changed via REST. Add editable=False as a model option to remove DatabaseErrors.
File Uploads
django-ewiz does support file uploads - just not in a direct manner (binary uploads to the file field won’t work [more research on abstracting that will be done later])
To mark a field as a file field, add help_text='file' as a model field option. Since trying to modify the field directly won’t work, adding editable=False is recommended to avoid confusion.
file_field = CharField(help_text='file', editable=False, db_column='attached_files')To upload a file, use the provided EwizAttacher class (from django_ewiz import EwizAttacher) with the following parameters:
settingsDict - the DATABASES dictionary that contains ewiz connection settings. e.g. settings.DATABASES[‘default’]
model - the model instance to which a file should be uploaded (the model must include one and only one file field). e.g. models.AccountRequest.objects.get(ticket_id = 1)
file_reference - a Python file object. If the file is coming from a django form, grab it via request.FILES[‘form_field_name’].file
file_name - the desired file name. If the file is coming from a django form, you can grab its name via request.FILES[‘form_field_name’].name
File Upload Example
forms.py
from django.forms import Form, FileField
class EwizUploadForm(Form):
uploaded_file = FileField(required=True)models.py
from django.db.models import Model, AutoField, CharField
class AccountRequest(Model):
ticket_id = AutoField(primary_key=True, db_column='id')
subject_username = CharField(help_text=':')
# Use this field only in conjunction with EwizAttacher - do not attempt to directly populate it
file_field = CharField(help_text='file', editable=False, db_column='attached_files')
class Meta:
db_table = u'account_request'
managed = False
verbose_name = u'Account Request'views.py
from django.conf import settings
from django.views.generic.edit import FormView
from django_ewiz import EwizAttacher
from .forms import EwizUploadForm
from .models import AccountRequest
class UploadDemoView(FormView):
template_name = "ewizdemo.html"
form_class = EwizUploadForm
def form_valid(self, form):
# Create a new account request
ticket = AccountRequest(subject_username=self.request.user.username)
ticket.save()
# Grab the file
file_reference = self.request.FILES['uploaded_file'].file
# Upload the file
EwizAttacher(settings_dict=settings.DATABASES['default'], model=ticket, file_reference=file_reference, file_name=self.request.user.username + u'.pdf').attach_file()Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django-ewiz-1.5.1.tar.gz.
File metadata
- Download URL: django-ewiz-1.5.1.tar.gz
- Upload date:
- Size: 28.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | dd8a06223c35b06aa5602670f5031ef0e7b55cf22875fda54e01b2b5017081e6 |
|
| MD5 | 117c4900a7387b008c1f014c718da7ea |
|
| BLAKE2b-256 | 7587c2e1254237208deb11edffc79e101232929087dd503746edfb01ad3d7296 |
File details
Details for the file django_ewiz-1.5.1-py2.py3-none-any.whl.
File metadata
- Download URL: django_ewiz-1.5.1-py2.py3-none-any.whl
- Upload date:
- Size: 18.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 26d0ab01a2959eb54257d7b1bfcd62be79eba879d739dd17741520d80433cd2f |
|
| MD5 | 70aff8fc0321a0c26d7f956552ce987c |
|
| BLAKE2b-256 | 29ef197705cffcdd431db3de4907aa1a91253ead2b7ab18554f37ad268eb79d6 |
