Skip to main content

The python middleware for neuron.js

Project description

Build Status

neuronjs

Python utilities and middleware for neuron.js

neuronjs analyzes the dependencies from user defined facades according to the dependency tree, and outputs <script> tags and configurations for neuron.js

The dependency tree can be generated by neuron-package-dependency

Install

$ pip install neuronjs

Usage

from neuronjs import Neuron

n = Neuron(
  dependency_tree=dependency_tree,  # must defined
  resolve=resolve,
  version=version,
  cache=cache,
  debug=False)

neuronjs could be used either in template file or your python controller.

Here is a sample Jinja2 template file.

  • dependency_tree dict the json.loads()ed dependency tree

  • resolve function(id)= (optional) implements your own custom resolver. resolve accepts one parameter id which can be either a str of module id or a list of module ids. If a str is passed in, the method should returns the resolved absolute url of the module id. If id is a list, an url of comboed script files should be returned.

  • debug function|bool=False tells neuronjs whether should switch on debug mode. When on debug mode, no javascript files of dependencies will be preloaded, and the output will not be compressed.

  • if debug is callable, neuronjs will use the return value of method debug

  • if debug is a boolean value, and debug is true, the debug mode will be on.

  • cache dict=None if cache is defined, it should contains 3 methods:

  • cache.has(key) returns bool

  • cache.get(key) looks up and returns the cached value by key

  • cache.set(key, value) sets the value by key

  • version str only works if cache is defined. neuronjs will uses version to generate the key to cache the output result

module id

<name>@<version><path>  # for example: 'jquery@2.0.0/jquery.js'

n.facade(entry, data=None)

  • entry str id of the entry module

Registers a facade entry with data. neuronjs will

Returns ''(empty string), so you can use this method in python template

n.combo(id…)

Returns ''

n.css(id)

Returns ''

n.output()

Returns str

n.output_css()

Returns str

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neuronjs-1.0.0.tar.gz (6.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page