Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An app to allow users to enter urls for custom defined fields. Couldn't think of a better name.
Python
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
crowdsource
.gitignore
License.txt
README.markdown
setup.py

README.markdown

django-crowdsource

django-crowdsource (for the lack of a better name) is an application to allow the users of your site to enter custom defined (url)fields for any object on your site.

As an example, say you have a list of objects representing the members of Congress. You can define fields such as Twitter stream, Home Page, Blog, Blog RSS Feed etc. django-crowdsource would then create a form for you which you can present to your users, allowing them to fill out one or all of these fields. These urls, upon the form's submission, will be saved to your database waiting to be verified by an admin.

django-crowdsource is released under the BSD license. See License.txt for more details.

Requirements

python >= 2.4

django >= 1.0

Installation

Currently, the only way to install django-crowdsource is to clone the git repository and create a symlink to the django-crowdsource/crowdsource folder to somewhere in your Django project's PYTHONPATH.

To clone the repository, you need to issue the following command:

git clone git://github.com/rmanocha/django-crowdsource.git

Quick Setup

settings.py

Add to INSTALLED_APPS:

'crowdsource'

Additionally, if you want to define a custom form (instead of using crowdsource.forms.CrowdSourcedEntryForm), add the following two settings:

'CROWD_SOURCED_ENTRY_FORM_MODULE' = 'custom form module'
'CROWD_SOURCED_ENTRY_FORM_NAME'   = 'custom form class name'

The first setting defines the module where the custom form class lives (so crowdsource.forms for example). The second setting defines the name of the form class to use (so CrowdSourcedEntryForm for example).

urls.py

You will need to add crowdsource.urls to your global URLConf. For example:

(r'crowdsource/', include('crowdsource.urls')), 

Usage Instructions

django-crowdsource works, for the most part, the same as django.contrib.comments. Templatetags are used to get a form object (or get the rendered form) and upon submission the relevant entries for the given object are created.

Templatetags

Start with loading the templatetags inside your templates

{% load crowdsource_tags %}

You now have two templatetags you can call to get the form object. The first is

{% get_crowdsourcedentry_form for obj as csentry_form %}

This tag will return a form object for obj as csentry_form. You can then use csentry_form to render the form into your template. You can also call this templatetag like so:

{% get_crowdsourcedentry_form for [app].[model] [object_id] as [varname] %}

The other templatetag available is:

{% render_crowdsourcedentry_form for obj %}

This tag renders the relevant form for obj. The template search path to render the form is:

'crowdsource/{{ app_label }}/{{ model }}/form.html',
'crowdsource/{{ app_label }}/form.html',
'crowdsource/form.html' 

You can also call this tag like so:

{% render_crowdsourcedentry_form for [app].[model] [object.id] %}

This tag passes the form context variable to the template which can be used to render the form in whatever way you like.

Finally, to get a list of verified CrowdSourcedEntry instances for a given model, you should call the following tag:

{% get_crowdsourcedentry_list for obj as varname %}

This will add varname to the current context. varname will contain a list of all verified CrowdSourcedEntry entries for the given object. You can then use the for tag to go through and display them.

You can also call the get_crowdsourcedentry_list tag like so:

{% get_crowdsourcedentry_list for [app].[model] [object.id] as varname %}

URLS

The form needs to be submitted to post-cs-entry, so in your template, the form's action should be something like:

<form method="post" action="{% post-cs-entry %}">
    {{ form }}
</form>

Notes

Forms

The form used by default is crowdsource.forms.CrowdSourcedEntryForm. You can customise this form by defining two settings:

CROWD_SOURCED_ENTRY_FORM_MODULE
CROWD_SOURCED_ENTRY_FORM_NAME

See the settings section to see what each does. If you do define a custom form, you should make it inherit from crowdsource.forms.CrowdSourcedEntrySecurityForm which will take care of all housekeeping for you.

By default, all url's saved by CrowdSourcedEntryForm are unverified (their existence is verified). You need to verify them by going into the admin and checking the Verified checkbox. You can change this behavior with a custom form.

View Redirection

After a succesfull entry is made, django-crowdsource redirects the user back to the url specified by the next parameter specified as a POST variable when data the data is sent to the view. So, your form fields should contain something like:

<input type="hidden" name="next" value="{{ my_next_url }}" />

If no next parameter is specified, the user is redirected to the target model instance's URL (using it's get_absolute_url() method).

Something went wrong with that request. Please try again.