freeze looks in the wrong directory for .git directory with 'src' package convention

If a package uses the convention that it puts its files in a “src” directory, then when you install from git, “pip freeze” will not recognize that it has been installed from a git repository.

One example is the piplint package.

To reproduce this bug using piplint:

$ pip install -e git://github.com/dcramer/piplint.git#egg=piplint-dev
$ pip freeze | grep piplint
piplint==0.1.1

Output should have been:

-e git://github.com/dcramer/piplint.git@c1c7921784d0315b659e0b53a2752ee5f0d202fe#egg=piplint-dev

The problem seems to be that “pip freeze” is looking in the wrong place for the “.git” directory. The location variable (I’m running pip 1.1) seems to be set to the $VENV/src/piplint/src/.git directory instead of $VENV/src/piplint/.git

Piplint has this in its setup.py:

setup(
    ...
    package_dir={'': 'src'},
    ...
)

And then it puts the code in src/piplint. Note that if the package_dir line is removed and the files are moved up from src/piplint to piplint, then the bug no longer manifests itself.

[granteagon]

@Permafacture I think your issue is related to not using the -e flag. If you don’t use that, pip will create a temporary build directory and will delete the dir after the build.

[Permafacture]

There may be a subtlety I’m missing but this is apparently fixed. In my case, the correct usage is:

pip install -e git://[github URL]#egg=Blah

Where github url is something like github.com/dcramer/piplint.git (so you’ve got to name the egg with the hash at the end). Check pip freeze afterwards to see that it worked.