release.bash

#!/bin/bash


SCRIPT=`readlink -f "$0"`
SCRIPTPATH=`dirname "$SCRIPT"`  # directory that contains this script

VENV_PY_2_DIR=$SCRIPTPATH/venv_py2;
VENV_PY_3_DIR=$SCRIPTPATH/venv_py3;

USE_PY_VERSION="python3"

usage="
    Usage:

        release.bash [options]

    Available options:
        -n|--dry-run           - do not do release, just build doc, and build packages
        --test-index           - upload to test pypi site
        --py2                  - use python 2
        --py3                  - use python 3 (default)
        --reuse-venv           - do not remove virtual environment, and reusse it on next call
        --no-docs              - do not generate and upload docs

"

# Disable doc generation
NO_DOCS=1;

# process cmdline options
while [[ $# -gt 0 ]]
do
    key="$1";
    case $key in
        -h|--help|help)
            echo "$usage";
            exit 0;
        ;;
        -n|--dry-run)
            DRY_RUN=1;
        ;;
        --test-index)
            TEST_PYPI_INDEX=1;
        ;;
        --py2)
            USE_PY_VERSION='python2';
        ;;
        --py3)
            USE_PY_VERSION='python3';
        ;;
        --no-docs)
            NO_DOCS=1;
        ;;
        --reuse-venv)
            REUSE_VENV=1;
        ;;
        *)
            echo "Unknown option $key";
            exit 1;
        ;;
    esac
    shift
done


set -e    # fail on any error

# make_venv <python-version> <dest dir>
function make_venv {
    local py_version=$1;
    local dest_dir=$2;

    if [ -d $dest_dir ] && [ -z $REUSE_VENV ]; then
        echo "Removing dest dir '$dest_dir'...";
        rm -rf $dest_dir;
        virtualenv -p $py_version $dest_dir;
    elif [ ! -d $dest_dir ]; then
        virtualenv -p $py_version $dest_dir;
    fi

    $dest_dir/bin/pip install --upgrade setuptools pip twine;
}

function build_docs {
    pip install --upgrade sphinx[all];
    (cp -f $SCRIPTPATH/README.rst $SCRIPTPATH/docs/source/intro.rst)
    python $SCRIPTPATH/setup.py build_sphinx;

}

function release_implementation {
    # install this project in virtual environment
    python $SCRIPTPATH/setup.py develop

    # Build options. if no dry run, then upload to pypi
    local setup_options=" sdist bdist_wheel ";

    # Build [and upload to pypi] project
    python $SCRIPTPATH/setup.py $setup_options;

    # If using test index, add it to upload options
    if [ -z "$TEST_PYPI_INDEX" ]; then
        python -m twine upload dist/*;
    else
        python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*;
    fi

    if [ -z $NO_DOCS ]; then
        build_docs;
    fi
}

function release_python_2 {
    local py_version=python2;
    local venv_dir=$VENV_PY_2_DIR;

    make_venv $py_version $venv_dir;

    source $venv_dir/bin/activate;
    release_implementation;
    deactivate;

    if [ -z $REUSE_VENV ]; then
        rm -r $venv_dir;
    fi
}

function release_python_3 {
    local py_version=python3;
    local venv_dir=$VENV_PY_3_DIR;

    make_venv $py_version $venv_dir;

    source $venv_dir/bin/activate;
    release_implementation;
    deactivate;

    if [ -z $REUSE_VENV ]; then
        rm -r $venv_dir;
    fi
}

function do_release {
    if [ ! -z $DRY_RUN ]; then
        echo "Running in 'dry-run' mode.";
    fi
    if [ "$USE_PY_VERSION" == "python3" ]; then
        release_python_3;
    elif [ "$USE_PY_VERSION" == "python2" ]; then
        release_python_2;
    else
        echo "Error";
    fi
}

do_release;