Skip to content

MPASolutions/django-webix

Repository files navigation

Django Webix

Version Build https://readthedocs.org/projects/django-webix/badge/?version=latest Codecov Issues Py versions License

Use the Webix JavaScript UI library with Django

Documentation

The full documentation is at https://django-webix.readthedocs.io.

Quickstart

Create a new virtualenv:

$ python -m venv django-webix
$ source django-webix/bin/activate

Install Django Webix:

$ pip install django-webix

Extra packages for Django Webix:

$ pip install django-webix-sender
$ pip install django-dal
$ pip install django-filtersmerger
$ pip install django-webix-filter

Add django-webix to your INSTALLED_APPS

INSTALLED_APPS = [
    # ...
    'django_webix',
    # ...
]

Add django-webix URLconf to your project urls.py file

from django.urls import path, include

urlpatterns = [
    # ...
    path('django-webix/', include('django_webix.urls')),
    # ...
]

Add internationalization to TEMPLATES

TEMPLATES = [
    {
        # ...
        'OPTIONS': {
            'context_processors': [
                # ...
                'django.template.context_processors.i18n',
            ],
        },
    },
]

Include webix static files folder in your django staticfiles folder as webix and add static configuration

STATICFILES_FINDERS = (
    'django.contrib.staticfiles.finders.FileSystemFinder',
    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
)
STATICFILES_DIRS = (
    os.path.join(BASE_DIR, 'staticfiles'),
)
STATIC_URL = '/static/'

Running Tests

Does the code actually work?

$ source <YOURVIRTUALENV>/bin/activate
$ (myenv) $ pip install tox
$ (myenv) $ tox

Sponsors

MPA Solutions Enogis

Contributors

Here is a list of Django-Webix's contributors.

Contributors