Metadata-Version: 2.0
Name: sprinter
Version: 1.4.2
Summary: a utility library to help environment bootstrapping scripts
Home-page: http://toumorokoshi.github.io/sprinter
Author: Yusuke Tsutsumi
Author-email: yusuke@yusuketsutsumi.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: System :: Software Distribution
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Requires-Dist: clint (>=0.3.3)
Requires-Dist: docopt (>=0.6.1)
Requires-Dist: pex (==1.1.0)
Requires-Dist: pip (==7.1.0)
Requires-Dist: requests (>=2.3.0)
Requires-Dist: six (>=1.4.1)
Requires-Dist: virtualenv (>=1.11.6)

========
sprinter
========


.. image:: https://travis-ci.org/toumorokoshi/sprinter.png
   :alt: build status
   :target: https://travis-ci.org/toumorokoshi/sprinter

.. image:: https://d2weczhvl823v0.cloudfront.net/toumorokoshi/sprinter/trend.png
   :alt: Bitdeli badge
   :target: https://bitdeli.com/free

Installation
------------

It's recommended to use Sprinter's standalone installer:

OSX::

    cd /tmp/; rm sprinter; curl -s https://raw.githubusercontent.com/toumorokoshi/sprinter/master/scripts/sandbox.sh > /tmp/sprinter; bash /tmp/sprinter

Debian-Based (e.g. Ubuntu)::

    cd /tmp/; rm sandbox.sh; wget https://raw.githubusercontent.com/toumorokoshi/sprinter/master/scripts/sandbox.sh -O sandbox.sh; bash sandbox.sh


You can also install sprinter using easy_install or pip (not recommended, it's easier to update with the standalone)::

    (sudo) easy_install http://github.com/toumorokoshi/sprinter/tarball/master

    (sudo) pip install http://github.com/toumorokoshi/sprinter/tarball/master

What is it?
-----------

A cross-platform environment bootstrapping framework!

Sprinter is a framework designed to making bootstrapping development
environments easier. There are three main components to a usable
sprinter environment:

* This python egg, to fully utilize the framework
* a sprinter.cfg file, which contains the configuration necessary to install features
* sprinter formulas, which each feature uses as it's instruction manual on how to setup, update, and remove itself

Read more about Sprinter on the `docs <http://sprinter.readthedocs.org/en/latest/>`_

Command list
------------

Install an environment::

  sprinter install ENVIRONMENT.cfg
  sprinter install http://myenvironment.cfg

Install the environment specified in the environment.cfg file. It will update an environment if it already exists.::

    sprinter update MY_ENVIRONMENT

Activate MY_ENVIRONMENT::

    sprinter activate MY_ENVIRONMENT

deactivate MY_ENVIRONMENT::

    sprinter deactivate MY_ENVIRONMENT

remove MY_ENVIRONMENT::

    sprinter remove MY_ENVIRONMENT


