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 planet.foss.org.my a few days ago.
Full documentation at http://docs.repoze.org/bfg
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:
root = MyModel()
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:
versions = versions
recipe = zc.recipe.egg
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.
../bin/paster create -t bfg_starter helloworld
then , edit buildout.cfg and add helloworld into the eggs section:
afterward, rerun buildout
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