Khufu/Pyramid component for managing javascript resources
Project description
Introduction
khufu_javascript provides various ways for including Javascript and stylesheet resources into your Khufu/Pyramid app. It currently requires Python 2.7 or higher (Python 3.x not tested).
Usage - Resource Registry
khufu_javascript.ResourceRegistry is a helper utility for managing Javascript and Stylesheet resources.
The curent ResourceRegistry can be looked up by calling (after including khufu_javascript with the configurator):
>>> from khufu_javascript import get_resource_registry
>>> config.include('khufu_javascript')
>>> helper = get_resource_registry(config)
>>> helper.add_javascript('/static/foobar.js')
>>> helper.add_stylesheet('http://someplace.com/style.css')
And inside a view (since khufu_javascript sets up a template-accessible khufu_resources object):
<!-- templates/foo.jinja2 -->
<html>
<head>
{{ khufu_resources.render()|safe }}
</head>
<body>
yes sir!
</body>
</html>
Usage - Dojo
khufu_javascript.dojo provides support for working with Dojo.
Setting up khufu_javascript.dojo is easy.
# config must be an instance of pyramid.config.Configurator
config.include('khufu_javascript.dojo')
config.register_script_dir('myproject:javascripts')
The previous example will iterate over all .js files in the javascripts directory relative to the myproject package (register_script_dir takes an asset spec). For each .js file found it scans for a dojo.provides('foo') entry and registers that module with khufu_javascript.
After having registered scripts, they can be accessed via the dojo view at the root of the site. If one of the javascripts found has “dojo.provides(‘foo.bar’)” then the dojo view will provide:
http://127.0.0.1:8080/dojo/foo/bar.js
Anyone working with Dojo modules knows that there still needs to a way to tell Dojo to look at /dojo/whatever when looking up non-core modules. Dojo handles this with djConfig which can be used to setup module load paths.
Here’s an example.
<!-- templates/foo.jinja2 -->
<html>
<head>
{{ khufu_dojo.render()|safe }}
</head>
<body>
yes sir!
</body>
</html>
The khufu_dojo.render() method will generate the appropriate <link>, <style>, and <script> elements for loading Dojo. It will also generate the appropriate djConfig object that configures the module loading path to work with our /dojo view.
Changes
1.0a2 (unreleased)
Fixed some doc bugs
1.0a1 (Nov-17-2011)
Now sets up resource helper for compiling list of javascripts/stylesheets
0.1 (Jul-10-2011)
first release
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.
