Metadata-Version: 1.1
Name: bootstrapper
Version: 0.2.1
Summary: Bootstrap Python projects with virtualenv and pip.
Home-page: https://github.com/playpauseandstop/bootstrapper
Author: Igor Davydenko
Author-email: playpauseandstop@gmail.com
License: BSD License
Description: ============
        bootstrapper
        ============
        
        .. image:: https://travis-ci.org/playpauseandstop/bootstrapper.png?branch=master
            :target: https://travis-ci.org/playpauseandstop/bootstrapper
        
        .. image:: https://pypip.in/v/bootstrapper/badge.png
            :target: https://crate.io/packages/bootstrapper
        
        Bootstrap Python projects or libraries by checking system pre-requirements if
        necessary, creating virtual environment, installing all requirements there and
        finally execute post-bootstrap hooks if any.
        
        Requirements
        ============
        
        * `Python <http://www.python.org/>`_ 2.6, 2.7, 3.2+
        
        Installation
        ============
        
        As easy as::
        
            # pip install bootstrapper
        
        License
        =======
        
        ``bootstrapper`` is licensed under the `BSD License
        <https://github.com/playpauseandstop/bootstrapper/blob/master/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] [-C HOOK] [--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
              -C HOOK, --hook HOOK  Execute this hook after bootstrap process.
              --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 -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
        =========
        
        0.2.1
        -----
        
        + Fix installing requirements in venv on MS Windows platform
        
        0.2
        ---
        
        + Full support of MS Windows platform
        + Ability to use bootstrapper for libraries with only ``setup.py`` as well as
          for projects with ``requirements.txt`` or other requirements file
        - Remove support of major/minor requirements in favor of `tox
          <http://tox.readthedocs.org>`_
        
        0.1.6
        -----
        
        + Initial support of MS Windows platform
        
        0.1.5
        -----
        
        + Real support of Python 3 versions
        + Enable Travis CI support
        + Refactor bootstrapper to Python module
        
        0.1.4
        -----
        
        + Support Python 3 versions
        
        0.1.3
        -----
        
        - Disable ``--use-mirrors`` key by default for installing requirements via
          ``pip`` cause of latest `PyPI CDN changes
          <https://twitter.com/pythonpackaging/status/339143339356061696>`_.
        
        0.1.2
        -----
        
        + Make ability to reuse cached pip files by storing them in ``~/.bootstrapper``
          user directory by default.
        
        0.1.1
        -----
        
        + Use ``--use-mirrors`` key by default when ``pip`` installs requirements to
          virtual environment.
        
        0.1
        ---
        
        - Initial release.
        
Keywords: bootstrap pip virtualenv
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: System :: Systems Administration
