Django management commands for the JSBuilder commands in Sencha SDK Tools. Unfortunately, the JSBuilder commands provided by Sencha Tools needs some workarounds to work when the HTML document and resources are not in the same directory. We have turned these workarounds into a Django management command available in the djangosenchatools app.
Report any issues at the github project page, and feel free to add your own guides/experiences to the wiki, and to contribute changes using pull requests.
Install the python package:
$ pip install djangosenchatools
Add it to your django project:
INSTALLED_APPS = [ ... 'djangosenchatools' ]
First, we need a Django ExtJS4 application. See django_extjs4_examples for
an example application. We use the
minimal_extjs4_app as our example.
senchatoolsbuild management command runs
You need to run the Django server (
manage.py runserver) for all commands except --listall.
Build one app
$ python manage.py senchatoolsbuild --url http://localhost:8000/minimal_extjs4_app/ --outdir /path/to/outdir
--outdir, the senchatoolsbuild command runs
create jsb and
sencha build, and puts the result in the
-v3 for full debug output if you want to see what the command does.
Build all INSTALLED_APPS
senchatoolsbuild can autodetect sencha apps and build them all in their
respective static directories. Run with
--help and see the help for
--buildall to see how apps are detected.
To list detected apps, their
$ python manage.py senchatoolsbuild --listall
-v3 to see skipped apps, and why they are skipped.
To build all detected apps, run:
$ python manage.py senchatoolsbuild --buildall
Build one app by name
You can build a single app in
INSTALLED_APPS using the same method of
detecting outdir and url as
$ python manage.py senchatoolsbuild --app minimal_extjs4_app
--watch to automatically rebuild on file changes:
$ python manage.py senchatoolsbuild --app minimal_extjs4_app --watch /path/to/directory/containing/minimal_extjs4_app
-v2 for debug out. By default, only
*.js-files trigger rebuild
events, however you can change this using these settings (shown with their defaults):
#: Files to include DJANGOSENCHATOOLS_WATCH_INCLUDE = ['*.js']
#: Files to exclude #: - Matched after INCLUDE, so you can include a general pattern, and #: exclude specific files or dirs. DJANGOSENCHATOOLS_WATCH_EXCLUDE = ['..swp', '~', '.pyc', '*.pyo',
_Note_: All patterns match against the absolute path of the file.
Integration with django_extjs4
This app is made to work with django_extjs4, however they are losely
coupled. The only place where you are likely to notice that they work together
senchatoolsbuild checks that
can disable this check using
Building apps that require authentication
Add the following to your
MIDDLEWARE_CLASSES += ['djangosenchatools.auth.SettingUserMiddleware'] AUTHENTICATION_BACKENDS = ('djangosenchatools.auth.SettingUserBackend',) SENCHATOOLS_USER = 'myuser'
SENCHATOOLS_USER is the user that you want to be authenticated as
(the user must exist). NEVER use this backend/middleware in production.
We reccommend that you create a separate settings.py for
where you set the required settings. Here is our
from settings import * EXTJS4_DEBUG = True MIDDLEWARE_CLASSES += ['djangosenchatools.auth.SettingUserMiddleware'] AUTHENTICATION_BACKENDS = ('djangosenchatools.auth.SettingUserBackend',) SENCHATOOLS_USER = 'grandma'
We use this settings module whenever we build apps using
$ python manage.py senchatoolsbuild --buildall --settings djangosenchatools_settings