Mercurial > hg > carton

annotate README.txt @ 31:8fef97a25925

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