Enhanced virtualenv bootstrap script creation.
Project description
About
everyapp.bootstrap provides an enhanced and customizable virtualenv bootstrap script. It aims to make it easy to bootstrap a virtual environment for your project.
This distribution includes a tool to generate a bootstrap script that will automatically create the virtual environment when run. By placing the bootstrap script in the root of your project’s source tree and making it available on a fresh checkout/clone from your version control repository, you make it easy for anyone who wants to hack on your project (including yourself!) to work in a consistent development environment.
Additionally, this enhanced bootstrap script can read a configuration file and perform additional actions beyond just creating a bare-bones virtual environment.
Features
Easy creation of a virtualenv bootstrap script.
Better defaults for virtualenv like using distribute instead of setuptools and always unzipping eggs.
Easy customization of the bootstrapping process.
Automatic installation of additional distributions using pip and/or easy_install.
Easy customization of pip and easy_install behaviour during distribution installation.
Automatically run additional commands after the bootstrapping is complete.
Status
This project is very young and the code should be considered Alpha quality. It has been minimally tested on Linux and Windows, under Python 2.6 and 2.7, but has not yet been seriously tested on any platform.
That said, it is largely just a wrapper and a few customizations on the production-grade virtualenv project, so it should be reasonably stable. It should also be mostly feature complete.
Dependencies
everyapp.bootstrap requires only distribute and virtualenv.
Installation
The easiest way to install this distribution is:
pip install everyapp.bootstrap
or:
easy_install everyapp.bootstrap
For additional installation options and tips see the doc/INSTALL.txt file.
Usage
In your project’s root directory, run:
mkbootstrap
This will generate a bootstrap.py script and a bootstrap.cfg configuration file. Edit bootstrap.cfg as desired, then run:
python bootstrap.py
This will create the virtual environment in the root directory for your project.
For additional bootstrap script options and information see the documentation and/or run the following commands:
mkbootstrap --help python bootstrap.py --help
Documentation and Support
FAQ: See doc/FAQ.txt.
Changes: See doc/NEWS.txt.
Known bugs: See doc/BUGS.txt and the issue tracker at the address below.
Bug/issue tracker: http://bitbucket.org/everyapp/bootstrap/issues?status=new&status=open
Source code repository: http://bitbucket.org/everyapp/bootstrap/
Contributing
There are still lots of improvements to make on this project. If you would like to help out, see the issue tracker, doc/BUGS.txt and the doc/TODO.txt file for details on what is left to do.
Also see the documentation and the doc/HACKING.txt file for more information on how to hack on code.
Licence
This distribution is licensed under the GNU General Public License version 3 or later (GPLv3+). This is free software: you are free to change and redistribute it under certain conditions. There is NO WARRANTY, to the extent permitted by law. For the full licence text, see doc/COPYING.txt.
The generated bootstrap script (bootstrap.py, by default) contains code from this distribution as well as code from the virtualenv project. It is therefore also licensed under the GPLv3+ as a derivative work.
Finally, all copyrights and moral rights on the the bootstrap configuration file that is generated by this distribution (bootstrap.cfg, by default) are explicitly disclaimed. It is in the public domain as it is intended to be copied and modified by anyone using this distribution.
Thanks
This project would not be what it is without the efforts of many people. Acknowledgements for their efforts can be found in the doc/THANKS.txt file.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.