bootstrapper 1.0.0a1

Requirements

• Python 2.6+

Installation

As easy as:

# pip install bootstrapper

License

bootstrapper is licensed under the terms of BSD License.

Configuration

You may configure any option of bootstrapper, virtualenv and pip by setting it in bootstrap.cfg file. For example:

[bootstrapper]
env = venv
hook = cp -r {PROJECT}/settings_local.py{{.def,}}

[pip]
quiet = True

[virtualenv]
quiet = True

By default, next configuration would be used:

[bootstrapper]
env = env
requirements = requirements.txt
quiet = False

[pip]
download_cache = ~/.bootstrapper/pip-cache/

Your configuration or arguments from command line overwrite default options, when arguments from command line overwrite your configuration as well.

Usage

$ bootstrapper --help
usage: bootstrapper [-h] [--version] [-c CONFIG]
                    [-p PRE_REQUIREMENTS [PRE_REQUIREMENTS ...]] [-e ENV]
                    [-r REQUIREMENTS] [-d] [-C HOOK] [--ignore-activated]
                    [--recreate] [-q]

Bootstrap Python projects and libraries with virtualenv and pip.

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -c CONFIG, --config CONFIG
                        Path to config file. By default: bootstrap.cfg
  -p PRE_REQUIREMENTS [PRE_REQUIREMENTS ...], --pre-requirements PRE_REQUIREMENTS [PRE_REQUIREMENTS ...]
                        List of pre-requirements to check, separated by space.
  -e ENV, --env ENV     Virtual environment name. By default: env
  -r REQUIREMENTS, --requirements REQUIREMENTS
                        Path to requirements file. By default:
                        requirements.txt
  -d, --install-dev-requirements
                        Install prefixed or suffixed "dev" requirements after
                        installation of original requirements file or library
                        completed without errors.
  -C HOOK, --hook HOOK  Execute this hook after bootstrap process.
  --ignore-activated    Ignore pre-activated virtualenv, like on Travis CI.
  --recreate            Recreate virtualenv on every run.
  -q, --quiet           Minimize output, show only error messages.

How it works?

There are two types of Python installables: libraries and projects, where library is Python code which only has setup.py and project is Python code that has at least requirements.txt, but could have setup.py as well.

Bootstrapper created as tool for installs Python projects, but time after time I needed to use it with libraries too, so from version 0.2 script check if passed requirements file exists on disk and if does just run,

$ pip install -r requirements.txt ...

inside of created virtual environment. But if requirements file does not exist, script sends other arguments to pip,

$ pip install -U -e . ...

and this is all magic.

So in pseudo-code installing Python library or project with bootstrapper is simple process of 4 steps:

check_pre_requirements(list)
create_virtual_environment(env)
install_library_or_project(env)
run_hook(hook)

Changelog