Skip to content
This repository has been archived by the owner on Mar 15, 2018. It is now read-only.

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Andy McKay committed Oct 2, 2014
1 parent 0199f30 commit db49cc6
Showing 1 changed file with 1 addition and 48 deletions.
49 changes: 1 addition & 48 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,48 +1 @@
This is the collection of zamboni's pure-python dependencies.

From your zamboni root, do this::

git clone --recursive git://github.com/mozilla/zamboni-lib.git vendor

Sit back and relax while all that downloads, then proceed on your merry way.

To keep it up to date::

pushd vendor && git pull && git submodule update --init && popd

If you currently have jbalogh as your origin, you should remove /vendor and
start over.


How zamboni-lib was made
------------------------

::

pip install -I --install-option="--home=`pwd`/vendor" --src='vendor/src' -r requirements/dev.txt

# ..delete some junk from vendor/lib/python...

# Create the .pth file so Python can find our src libs.
find src -type d -depth 1 >> zamboni.pth

# Add all the submodules.
for f in src/*; do
pushd $f >/dev/null && REPO=$(git config remote.origin.url) && popd > /dev/null && git submodule add $REPO $f
done
git add .


Using your own vendor lib
-------------------------

We add these lines to our manage.py file, since it's the entrypoint to
everything we do in zamboni. Adjust as you see fit. ::

import site
site.addsitedir('vendor')
site.addsitedir('vendor/lib/python')

``addsitedir`` adds that directory to the Python path and looks for other
``.pth`` files in that dir. We use a ``.pth`` in vendor to load our ``src/``
packages, and pip may have added other ``.pth`` files in ``vendor/lib/python``.
zamboni-lib was part of zamboni, but it is no longer used.

0 comments on commit db49cc6

Please sign in to comment.