This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
[![Build Status](https://travis-ci.org/dlapiduz/django-widgeter.png?branch=master)](https://travis-ci.org/dlapiduz/django-widgeter)

Widgeter
========================

A simple engine for django backend widgets based on https://github.com/marcinn/django-widgets


Features
-----------------

- Creation of custom widgets in reusable apps
- Rendering of widgets by name
- Rendering of widget blocks without previous knowledge of widget names
- Autodiscovery of widgets from all installed apps


Installation
-----------------

1. Install the package using `pip install django-widgeter`
1. Add `widgeter` to your `INSTALLED_APPS` in `settings.py`


Defining a Widget
-----------------

Add a `widgets.py` file on your application with the following statements.

- Widgets can be defined with a template (and optionally a context):
```
from widgeter.base import Widget

class HelloWorld(Widget):
template = 'hello_world/widget.html'

def get_context(self, context, options=None):
return { 'message': u'Hello World!' }
```

or with a render function:
```
from widgeter.base import Widget

class HelloWorld(Widget):
def render(self, context, options=None):
return u'Hello world!'

```
- Register your widget:
```
from widgeter.registry import registry

registry.register('hello_world', HelloWorld())
```


Rendering a Widget
-----------------

On a template you first have to load the template tags and then render the particular widget:

```
{% load widgeter %}
{% widget "hello_world" %}
```

You can also pass variables to your widget:

```
{% load widgeter %}
{% widget "hello_world" current_user %}
```


Using Blocks
-----------------

Widget blocks allow you to render widgets without previously knowing the names for them.
The autodiscovery process will add them to the registry and you can the look them up by block name.
Priorities can also be assigned to render them in order.

- First define a block on the widget:
```
from widgeter.base import Widget

class HelloWorld(Widget):
block = 'home'
priority = '1'
template = 'hello_world/widget.html'

def get_context(self, context, options=None):
return { 'message': u'Hello World!' }
```

- Then, on the template, use the `widget_block` tag:
```
{% load widgeter %}
{% widget_block "home" current_user %}
```

Running the Tests
------------------------------------

You can run the tests with via::

python setup.py test

or::

python runtests.py
Release History

Release History

0.1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django-widgeter-0.1.tar.gz (4.2 kB) Copy SHA256 Checksum SHA256 Source Aug 16, 2013

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting