repoze.bfg - Introduction and bootstrapping it on buildout

2 months without a post here .. T_T ... must .. restart .. blogging ...

Anyway, I've been poking around with repoze.bfg since last week and growing to love it by the days. Been thinking to post a blog on getting started on it but was a bit lazy .. until I saw lowkster's post about bfg at a few days ago.

Full documentation at

A little review

I love Zope Component Architecture because the modularity/reusability it offers, but Bluebream, Grok and Zope2 feels a bit big for simple web apps or for introducing ZCA to new people. Then I saw BFG.

BFG simplifies many concepts which I'm familiar with in Zope2/Zope3, and it does it without overwhelming developers with other parts of the framework. Not endorsing any type of storage backend, and giving an option between URL routing and traversal or a mix of both is a plus.

The initial base code is simple and straightforward, and there are no need to subclass any parent class when you want to create your initial project.

The starter project is as simple as:
class MyModel(object):

root = MyModel()

def get_root(request):
return root
def my_view(request):
return {'project':'helloworld'}

A registration of the view in configure.zcml:

And its template file which uses TAL compatible markup.

As the initial requirement is simple, and theres close to no enforcement on how developers supposed to write something on it, it made it easy for new people to quickly learn it and start being productive. BFG too, being something that uses many Zope concepts, can utilize many existing Zope/Z3C components out there, and if a developer know how to utilize ZCA well, what developed on a BFG project may also be componentized and reused in other frameworks.

What to know more on whats cool with BFG? .. read their Sales Pitch ;)

Installation on Buildout

Depending on your distribution, BFG might be available in your distro repository (Fedora have it). However, being a Zope/Plone developer as my main job, whenever it comes to installing python applications from pypi, I tend to prefer to use buildout to create a self-contained environment. So I'll use buildout here too.

First, if you don't have zc.buildout yet, install it using:
$ easy_install zc.buildout

Now lets create the contained environment
$ mkdir -p ~/repozebuildout/src
$ cd ~/repozebuildout

Then create a buildout.cfg file in the directory with this config:
parts =
develop =
versions = versions

recipe = zc.recipe.egg
eggs =
interpreter = python
entry-points = paster=paste.script.command:run

repoze.bfg = 1.2.1

What the buildout config will do is, it will create a buildout with repoze.bfg framework and its dependencies installed, with an interpreter script configured for the buildout environment, and a paster script.

Now initialize the buildout
$ buildout init
$ ./bin/buildout -vv

After the buildout initialization is done, you may start creating the project skeleton.

Creating your first project

There are several templates to choose from: bfg_starter, bfg_routesalchemy, bfg_alchemy, and bfg_zodb.

bfg_starter template simply give a very basic bfg skeleton to get started. Those who are familiar with Pylons/Django might want to look at bfg_routesalchemy and those who are familiar with Zope might want to look at bfg_alchemy and bfg_zodb.

For this example, i'll just create a simple project using bfg_starter template.

cd src/
../bin/paster create -t bfg_starter helloworld
cd ..

then , edit buildout.cfg and add helloworld into the eggs section:

eggs =

afterward, rerun buildout
./bin/buildout -vvv

Once that is done, you may start the server using:
./bin/paster serve src/helloworld/helloworld.ini

Now you can start developing on BFG!. Read the documentation to get you started in developing on BFG.

Happy hacking :D


Izad Che Muda said…
Pay only for what you eat? Awesome.

Dude, I'm dying for this kind of web framework for PHP. Do you know any?
Unknown said…
PHP is not quite Object Oriented, which makes its rare to find frameworks on PHP coz most frameworks utilizes OO patterns.

Theres 2 PHP frameworks that I've seen:


though both of them I dont quite like :P

Theres always option to learn Python :D
Izad Che Muda said…
Yeah..I've used both of 'em. CakePHP is quite good. It's basically a Rails clone. But it has too many features that I probably won't use.

Python (especially Django framework) is awesome from what I've learnt so far, but PHP is more web hosting-friendly and CHEAP, hosting-wise.
Unknown said…
If you just need a hosting for development purpose, theres Google App Engine and Repoze supports deploying on GAE: docs here

Or you can always try finding any webhosting that supports mod_wsgi.

Theres this one module which allow you to bridge FastCGI(which many hosting supports) to WSGI but I havent tried it myself, as I have my own server which have mod_wsgi.

Popular posts from this blog

Announcing PlatoCDP, a Plone distribution for enterprises.

Adding simple popup to Plone frontpage

An Open Letter for the Rector of PETRONAS University of Technology