Dependencies

Installation

PIP:

pip install django-trello-broker

Basic Manual Install:

$ python setup.py build
$ sudo python setup.py install

Alternative Install (Manually):

Place trello_broker directory in your Python path. Either in your Python installs site-packages directory or set your $PYTHONPATH environment variable to include a directory where the trello_broker directory lives.

Go to http://yourdomain.com/admin/ (or your admin URL) and add BitBucket Repositories. After saving you’ll be able to add a new “Rule”. Once you save that rule, you’ll be able to add another. Currently there are only 2 rules allowed. “Referenced” and “Fixes / Closes”.

Referenced

When a card has been referenced in a commit message, this rule will be triggered.

Example

Simply using “#<card-short-id>” works. For instance, “Starting working on new feature for #213”

Fixes / Closes

When a card has been referenced in a commit message but also uses a “fix” or “close” prefix

Example:

One of the following words following by the card short ID. Words are “fix(ed|es)” or “close(d|s)”. This is case insensitive. For instance, “Finished work for new feature. Closes #213”

Note Be sure to include the access_key if you stored one in your BitBucket Repo in the Django Admin. For instance, if you used “foobar” as your access key in Django admin, in the BitBucket settings you need to pass in the access key like so: http://yourdomain.com/broker/?access_key=foobar

Settings

There are a few settings that the application supports.

TRELLO_BROKER_USE_CELERY - Defaults to False. If True, the broker processor will use the celery task “celery_process_commits” which is simply a wrapper for the normal “process_commits” function to run via your celery setup.

TRELLO_BROKER_RESTRICT_IPS - Defaults to False. If True, the broker will check that the client sending the request comes from the specified BitBucket broker servers. See: BitBucket IP List Here

TRELLO_BROKER_BITBUCKET_IPS - A list of client IP’s that are allowed to POST to the broker. Default’s to

['131.103.20.165', '131.103.20.166']

This setting depends on TRELLO_BROKER_RESTRICT_IPS being set to True

Templates

There is a single template that is used and it holds the message used to generate the comment left on the Trello card.:

Admin Actions

Also included is a simple Admin Action that makes it easy for you to re-populate one, or many, of your Trello boards via the Admin list page. Just select the boards you want to update, select the action, hit “Go”.

Example in Action

Here’s a simple screenshot from one of our development cards

Commercial Support

This software, and lots of other software like it, has been built in support of many of
Netlandish’s own projects, and the projects of our clients. We would love to help you
on your next project so get in touch by dropping us a note at hello@netlandish.com.