peep 0.3

Switching to Peep

0. Install peep:

   pip install peep

1. Use peep to install your project once:

   cd yourproject
   peep install -r requirements.txt

   You’ll get output like this:

   <a bunch of pip output>
   
   The following packages had no hashes specified in the requirements file,
   which leaves them open to tampering. Vet these packages to your
   satisfaction, then add these "sha256" lines like so:
   
       # sha256: L9XU_-gfdi3So-WEctaQoNu6N2Z3ZQYAOu4-16qor-8
       Flask==0.9
   
       # sha256: YhddA1kUpMLVODNbhIgHfQn88vioPHLwayTyqwOJEgY
       futures==2.1.3
   
       # sha256: qF4YU3XbdcEJ-Z7N49VUFfA15waKgiUs9PFsZnrDj0k
       Jinja2==2.6
   
       # sha256: u_8C3DCeUoRt2WPSlIOnKV_MAhYkc40zNZxDlxCA-as
       Pygments==1.4
   
   Not proceeding to installation.

2. Vet the packages coming off PyPI in whatever way you typically do.

3. Add the recommended hash lines to your requirements.txt, each one directly above the requirement it applies to. (The hashes are of the original, compressed tarballs from PyPI.)

4. In the future, always use peep install to install your requirements. You are now cryptographically safe!

The Fearsome Warning

If, during installation, a hash doesn’t match, peep will say something like this:

THE FOLLOWING PACKAGES DIDN'T MATCHES THE HASHES SPECIFIED IN THE
REQUIREMENTS FILE. If you have updated the package versions, update the
hashes. If not, freak out, because someone has tampered with the packages.

    requests: expected FWvz7Ce6nsfgz4--AoCHGAmdIY3kA-tkpxTXO6GimrE
                   got YhddA1kUpMLVODNbhIgHfQn88vioPHLwayTyqwOJEgY

It will then exit with a status of 1. Freak out appropriately.

Other Niceties

• peep implicitly turns on pip’s --no-deps option so unverified dependencies of your requirements can’t sneak through.

• All non-install commands just fall through to pip, so you can use peep all the time if you want. This comes in handy for existing scripts that have a big $PIP=/path/to/pip at the top.

• peep-compatible requirements files remain entirely usable with pip, because the hashes are just comments, after all.

Version History

0.3

• Support Windows and other non-Unix OSes.

• The hash output now includes the actual version numbers of packages, so you can just paste it straight into your requirements.txt.

0.2.1

• Add a shebang line so you can actually run peep after doing pip install peep. Sorry, folks, I was doing setup.py develop on my own box.

0.2

• Fix repeated-logging bug.

• Fix spurious error message about not having any requirements files.

• Pass pip’s exit code through to the outside for calls to non-install subcommands.

• Improve spacing in the final output.

0.1

• Proof of concept. Does all the crypto stuff. Should be secure. Some rough edges in the UI.