debianize

README.rst

Debianize, create debian packages from python packages

Debianize uses fpm (https://github.com/jordansissel/fpm) to create debian packages from python source directories. The only thing it really adds, is that debianize will also create packages for all depencencies that your source package has (install_requires). Debianize will only create a debian package from a python package. So you need a setup.py.

Usage

debianize.sh -m "nobody <nobody@example.com>" -i django -i buildthistoo

Accepted flags

-m The maintainer string ("nobody <nobody@example.com>") (If different as defined in setup.py)
-i Using this flag makes following dependencies explicit. It will only
   build dependencies listed in install_requires that match the regex
   specified after -i. Use -i multiple times to specify multiple packages
-I Use this flag to ignore a dependencies from being built. Packages that
   match the regex specified after -I. Use -I multiple times add more ignore
   regexes.
-f full path to fpm binary to use.
-p full path to pip binary to use.

All flags are optional. Anything after an unknown flag has been encountered, will be passed to fpm as arguments. -i and -I are mutually exclusive.

Upstart

If you've got a folder named upstart next to your setup.py, this folder will be packaged as well, with the same version number as your package, but adding a .d postfix to your package name.

debianize.sh

#! /bin/bash

##############################################################################
# HELP
##############################################################################
read -d '' HELP <<- EOF
Usage: debianize.sh -m "nobody <nobody@example.com>" -i django -i buildthistoo
   -m The maintainer string ("nobody <nobody@example.com>")
   -i Using this flag makes following dependencies explicit. It will only
      build dependencies listed in install_requires that match the regex
      specified after -i. Use -i multiple times to specify multiple packages
   -I Use this flag to ignore a dependencies from being built. Packages that
      match the regex specified after -I. Use -I multiple times add more ignore
      regexes.
   -f full path to fpm binary to use.
   -p full path to pip binary to use.


All flags are optional
Anything after an unknown flag has been encountered, will be passed to fpm as arguments.
-i and -I are mutually exclusive.

EOF

##############################################################################
# Pre removal script
##############################################################################
PRERM_PATH="/tmp/${RANDOM}.preremove"

cat > $PRERM_PATH <<- EOF
#!/bin/sh
set -e

if which pyclean >/dev/null 2>&1; then
	pyclean -p <%= name %>
else
	dpkg -L <%= name %> | grep \.py$ | while read file
	do
		rm -f "${file}"[co] >/dev/null
  	done
fi
EOF

chmod u+x $PRERM_PATH

##############################################################################
# CONSTANTS
##############################################################################
MAINTAINER="somebody@example.com"
FOLLOW_DEPENDENCIES=""
FPM_BIN="fpm"
PIP_BIN="pip"
LAST_OPTION=1
IGNORE_DEPENDENCIES=""

##############################################################################
# OPTION PARSER
##############################################################################
while getopts ":m:i:I:p:f:" opt; do
  case $opt in
    m)
      MAINTAINER=$OPTARG
      LAST_OPTION=$OPTIND
      ;;
    i)
      if [[ $FOLLOW_DEPENDENCIES == "" ]]; then
          FOLLOW_DEPENDENCIES=$OPTARG
      else
          FOLLOW_DEPENDENCIES="$FOLLOW_DEPENDENCIES|$OPTARG"
      fi
      LAST_OPTION=$OPTIND
      ;;
    I)
      if [[ $IGNORE_DEPENDENCIES == "" ]]; then
          IGNORE_DEPENDENCIES=$OPTARG
      else
          IGNORE_DEPENDENCIES="$IGNORE_DEPENDENCIES|$OPTARG"
      fi
      LAST_OPTION=$OPTIND
      ;;
    f)
      FPM_BIN=$OPTARG
      LAST_OPTION=$OPTIND
      ;;
    p)
      PIP_BIN=$OPTARG
      LAST_OPTION=$OPTIND
      ;;
    \?)
      if [[ $OPTARG =~ \?|h ]]; then
          echo "$HELP" >&2
          exit
      fi
      break
      ;;
    :)
      echo "Option -$OPTARG requires an argument." >&2
      exit 1
      ;;
  esac
done

# remove options from args
shift $(($LAST_OPTION - 1))

if [[ $EUID -ne 0 ]]; then
   echo "You must be root to build a debian package." 1>&2
   exit 100
fi


##############################################################################
# MAIN PACKAGE BUILD
##############################################################################
# remove existing packages
echo "Cleaning old .deb files."
rm -f *.deb

# build package
echo "building package"
$FPM_BIN -s python -t deb \
        --maintainer="$MAINTAINER" \
        --exclude=*.pyc \
        --exclude=*.pyo \
        --depends=python \
        --category=python \
        --before-remove=$PRERM_PATH \
        --template-scripts \
        --python-install-lib=/usr/lib/python2.7/dist-packages/ \
        "$@" setup.py

if [ `which dpkg-deb` ]; then
    # only do this if dpkg-deb is installed.
    PACKAGE_VERSION=`dpkg-deb --info *.deb | grep Version | cut -c 11-`
    PACKAGE_NAME=`dpkg-deb --info *.deb | grep Package | cut -c 11-`

    if [ -d upstart ]; then
        echo "building extra package in upstart dir"
        cd upstart
        CONFIG_FILES=`find etc -type f | grep -v svn | xargs -i% echo "--config-files=/%"`
        $FPM_BIN $CONFIG_FILES -x ".svn*" -x "**.svn*" -x "**.svn**" --maintainer="$MAINTAINER" --category=misc -s dir -t deb -n "$PACKAGE_NAME.d" -v "$PACKAGE_VERSION" -d "$PACKAGE_NAME (= $PACKAGE_VERSION)" -a all *
        if [ $? -ne 0 ]; then
        	echo "error occured while building upstart-package"
        	exit
        fi 
        mv $PACKAGE_NAME* ..
        cd ..
    fi
fi


##############################################################################
# DEPENDENT PACKAGES BUILD
##############################################################################
echo "-----------------------------------------------------------"
echo "Downloading dependencies."

# download dependencies
HASH=`openssl dgst -sha1 setup.py | cut -c 17-`
PACKAGE_VAULT=/tmp/.$HASH
mkdir -p $PACKAGE_VAULT
$PIP_BIN -q install --upgrade --no-install --no-use-wheel --build=$PACKAGE_VAULT -e .

echo "processing dependencies."
for NAME in `ls $PACKAGE_VAULT`
do
    echo -n "package $NAME found in dependency chain, "
    if [[ $NAME =~ $FOLLOW_DEPENDENCIES ]]; then
        if ! [[ $NAME =~ $IGNORE_DEPENDENCIES ]] || [[ $IGNORE_DEPENDENCIES == "" ]]; then
        echo "BUILDING ...."
        $FPM_BIN -s python -t deb \
                --maintainer="$MAINTAINER" \
                --exclude=*.pyc \
                --exclude=*.pyo \
                --depends=python \
                --category=python \
                --before-remove=$PRERM_PATH \
                --template-scripts \
                --python-install-lib=/usr/lib/python2.7/dist-packages/ \
                $PACKAGE_VAULT/$NAME/setup.py
        else
            echo "Explicitly ignored, skipping ...."
        fi
    else
        echo "skipping ...."
    fi
done
echo "-----------------------------------------------------------"

##############################################################################
# CLEAN UP
##############################################################################
rm -fr $PACKAGE_VAULT
rm $PRERM_PATH