Mercurial > hg > carton
comparison README.txt @ 31:8fef97a25925
near version bump and documentation
| author | Jeff Hammel <jhammel@mozilla.com> |
|---|---|
| date | Mon, 11 Jul 2011 12:56:46 -0700 |
| parents | bb19d3dac4c5 |
| children | 00ca88ef1c33 |
comparison
equal
deleted
inserted
replaced
| 30:0b9c124f128b | 31:8fef97a25925 |
|---|---|
| 1 See the docstring of carton.py for documentation | 1 carton |
| 2 ====== | |
| 3 | |
| 4 make a self-extracting virtualenv from directories or URLs of packages | |
| 5 | |
| 6 See the docstring of carton.py for documentation: http://k0s.org/mozilla/hg/carton/file/tip/carton.py#l3 | |
| 7 | |
| 8 Carton provides a one-file portable package of a virtualenv and all of | |
| 9 its software. | |
| 10 | |
| 11 | |
| 12 Why did you write this thing? | |
| 13 ----------------------------- | |
| 14 | |
| 15 For whatever reasons, people have trouble using virtualenv so I | |
| 16 figured I'd make that easy. People also seem to believe that you can | |
| 17 zip up a virtualenv and treat it as portable. In general, virtualenvs | |
| 18 are architecture and library dependent, so this isn't a good idea. | |
| 19 carton works around this problem by packaging the instructions | |
| 20 necessary to make the virtualenv instead of dealing with | |
| 21 library/hardware incompatabilities. | |
| 22 | |
| 23 | |
| 24 Should I use carton for my deployment strategy? | |
| 25 ----------------------------------------------- | |
| 26 | |
| 27 Maybe. Carton is pretty minimalist. It does effectively one thing: | |
| 28 makes a file that unfolds to a virtualenv with software setup for | |
| 29 development. If this fits in with what you want to do, then sure! If | |
| 30 not, then probably not. | |
| 31 | |
| 32 | |
| 33 TODO | |
| 34 ---- | |
| 35 | |
| 36 carton is essentially finished. Features can be added by request | |
| 37 (just mail me: jhammel __at__ mozilla __dot__ com), but the scope of | |
| 38 the project is pretty much fulfilled. | |
| 39 | |
| 40 There are a few items I would like to add: | |
| 41 | |
| 42 - currently, carton only works if connected to a network or if a local | |
| 43 virtualenv tarball is specified with `--virtualenv`. I would like to | |
| 44 make a script, `regen_virtualenv.py`, that would add a hashed value | |
| 45 of the virtualenv tarball to the global `VIRTUAL_ENV` | |
| 46 variable. Similarly, one should be able to retrieve the stripped | |
| 47 down version of the script without this hash if desired | |
| 48 | |
| 49 - ... and being able to take virtualenv from its import path, if | |
| 50 available | |
| 51 | |
| 52 - it would be nice to be able to specify a post-deployment script to | |
| 53 be run | |
| 54 |