1257551 - Fix setup.py in python_moztelemetry

Status: RESOLVED FIXED

(Cloud Services Graveyard :: Metrics: Pipeline, defect, P2)

Description

[Mark Reid [:mreid]]

When running `python setup.py sdist upload` from the python_moztelemetry repo, the resulting package does not include histogram_tools.py, nor does it fetch that file when installing from PyPI.

That file should ideally be downloaded during pip install, or if not, included in the dist tarball uploaded to PyPI.

Steps to reproduce:
- git clone [e-mail]:mozilla/python_moztelemetry.git
- increment the package version in setup.py
- python setup.py sdist upload
- cd <some other dir>
- virtualenv foo
- source foo/bin/activate
- pip install python_moztelemetry
- python -c "import moztelemetry"

If you see an error like:
ImportError: No module named histogram_tools

then the package is broken.

The success case should either be quiet or print a warning like:
Unable to parse whitelist...

Comment 1

[Thomas Huelbert]

Over to Mauro

Comment 2

[Mauro Doglio [:mdoglio]]

I was able to reproduce this on my local machine using easy_install. On the other hand, `pip install` works as expected.
Before I spend time debugging this, do we have a reason to not include a copy of histogram_tools.py in the repository?
Looking at the changelog on m-c it doesn't seem to be updated very often.
Imho adding that file to the python_moztelemetry repo would make both testing and deploying the library more deterministic. In exchange for that we would have to bump up the package version when histogram_tools is updated, which is a little bit more work. But again, it doesn't seem to happen very often.
:mreid any opinion on that?

Comment 3

[Mark Reid [:mreid]]

I think it's a good idea to include the histogram_tools.py file in the pip package. That way the code in the package is always the same for a given version, regardless of when you install it.

I'm not sure the best way to enforce / encourage the version bump when that file changes in the tree.

Comment 4

[Mauro Doglio [:mdoglio]]

I think it's up to the reviewer of the patch on mozilla-central to bump up the version on the github repo. I'll try to come up with some notification service on the long term.
I'm copying histogram_tools.py to the python_moztelemetry repository as part of https://github.com/mozilla/python_moztelemetry/pull/63/

Comment 5

[Mauro Doglio [:mdoglio]]

histogram_tools.py was added to the repository in https://github.com/mozilla/python_moztelemetry/commit/1ee48482f6aa43e944327f7a7183bc48bfe8ac36