pylibmc

Makefile

@@ -2,6 +2,7 @@ docs:
 	mkdir -p site
 	shocco -t 'Python Buildpack Compiler' ./bin/compile > site/index.html
 	shocco -t 'Django Buildpack Compiler' ./bin/steps/django > site/django.html
+	shocco -t 'Pylibmc Buildpack Compiler' ./bin/steps/pylibmc > site/pylibmc.html
 
 site: docs
 	cd site && git add -A && git commit -m 'update' && git push heroku master

bin/steps/pylibmc

 #!/usr/bin/env bash
 
+# This script serves as the Pylibmc build step of the
+# [**Python Buildpack**](https://github.com/heroku/heroku-buildpack-python) 
+# compiler. 
+# 
+# A [buildpack](http://devcenter.heroku.com/articles/buildpacks) is an 
+# adapter between a Python application and Heroku's runtime.
+#
+# This script is invoked by [`bin/compile`](/).
+
+# The location of the pre-compiled libmemcached binary.
 VENDORED_MEMCACHED="http://cl.ly/0a191R3K160t1w1P0N25/vendor-libmemcached.tar.gz"
 
-# if pylibmc within requirements, use vendored libmemcached
+# If pylibmc exists within requirements, use vendored libmemcached.
 if (grep -Fiq "pylibmc" requirements.txt)
 then
     echo "-----> Noticed pylibmc. Bootstrapping libmemcached."
@@ -11,6 +21,7 @@ then
     if [ -d "vendor/lib/sasl2" ]; then
       export LIBMEMCACHED=$(pwd)/vendor
     else
+      # Download and extract libmemcached into target vendor directory.
       curl -s -L -o tmp-libmemcached.tar.gz $VENDORED_MEMCACHED
       tar -zxvf tmp-libmemcached.tar.gz > /dev/null
       rm tmp-libmemcached.tar.gz