Git Product home page Git Product logo

virtualenv-bootstrap's Introduction

Virtualenv Bootstrap

The best way to have people contributing to your project is to make easy for them to just checkout and run.

Virtualenv Bootstrap helps your contributor to just clone your repository and setup a development environmet with just one command:

  1. Clone the repository:

    git clone [your repo]
    
  2. Bootstrap the development environment:

    python bootstrap
    

It works based on built-in Virtualenv capabilities, but it's completely isolated. Perfect even for newcommers who don't still have or understand Python Packaging tools.

How it works?

Virtualenv Bootstrap detects your current python interpreter and:

  1. Creates a Virtualenv for your project;
  2. Installs Distribute;
  3. Setups a simple postactivate file for those who use Virtualenvwrapper;
  4. Searches for your requirements.txt at your repository root and install all your dependencies with Pip;

How to add it to your project?

Just copy the bootstrap directory to you repository directory.

You can easely do this with the following script:

curl -L https://github.com/henriquebastos/virtualenv-bootstrap/tarball/master | tar -xzv --strip-components 1 */bootstrap

How to extend it?

You might want to automate some other tasks to make the setup of complex projects really easy, like:

  • runing tests
  • detecting presence of services your project needs
  • etc.

For that, just add your own commands to the function after_install on your bootstrap/hook.py.

License

Licensed under an MIT-style permissive license.

Bad Note: for now it only supports python 2.6 and 2.7

virtualenv-bootstrap's People

Contributors

henriquebastos avatar

Watchers

Eduardo "Stalinho" Oliveira de Carvalho avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.