Update setup.py to enable pip installs direct from github #12

crbunney · 2015-08-11T18:38:32Z

Edit: Did a bit more work on this and rewrote the pull request description to be clearer

I've found that you can't install the uap-python library direct from github using pip or as a dependency for a project installed using setuptools.

There are 2 possible URLs that you can point pip/setup.py at:

Git repo: git+https://github.com/ua-parser/uap-python.git@master#egg=ua-parser-0.4.0
Tarball: https://github.com/ua-parser/uap-python/tarball/master#egg=ua-parser-0.4.0

There appears to be 2 issues:

The tarball download doesn't include the uap-core submodule, so doesn't include the regexes.yaml
The setup.py install command doesn't install the regexes.yaml and regexes.json files (unlike the develop and sdist commands)

I can't find a workaround/solution for the tarball download not including the submodule, it seems to be a limitation of the feature that github provides.

For the installation of the regexes files, I updated the setup.py (hence this pull request)

Test Methodology

I ran all the tests within a virtualenv using pip 1.5.6 (although I'm confident it works fine with later versions as well).
Between each test case I ran wipeenv from virtualenvwrapper to remove all installed python modules.
To check whether the test passed, I ran python -c 'import ua_parser.user_agent_parser', which produces a traceback if the regexes aren't installed correctly.
For the tests that installed uap-python as a dependency declared in a setup.py, I created a simple project with the following setup.py:

from setuptools import setup

setup(
    name='ua-test',
    version='0.1',
    packages=['ua-test'],
    url='',
    license='',
    author='Chris Bunney',
    author_email='[email protected]',
    description='',
    install_requires=[
        'ua-parser==0.4.0'
    ],
    dependency_links=[
        'INSERT_TEST_URL_HERE'
    ]
)

These are the tests cases I tried:

pip installs:
- Direct pip install using git URL: pip install <git_url>
- Direct pip install in editable mode using git URL: pip install -e <git_url>
- Direct pip install using tarball URL: pip install <tarball_url>
- Direct pip install in editable mode using tarball URL: pip install -e <tarball_url>
setup.py installs (executed from test project root)
- setup.py install using git URL: pip install --process-dependency-links . # (dependency_links=['<git_url>'])
- setup.py install in editable mode using git URL: pip install --process-dependency-links -e . # (dependency_links=['<git_url>'])
- setup.py install using tarball URL: pip install --process-dependency-links . # (dependency_links=['<tarball_url>'])
- setup.py install in editable mode using tarball URL: pip install --process-dependency-links -e . # (dependency_links=['<tarball_url>'])

Test Results Using ua-parser/uap-python/master
git URL: git+https://github.com/ua-parser/uap-python.git@master#egg=ua-parser-0.4.0
tarball URL: https://github.com/ua-parser/uap-python/tarball/master#egg=ua-parser-0.4.0

Test Case	Result
Direct pip install using git URL	FAILED
Direct pip install in editable mode using git URL	FAILED
Direct pip install using tarball URL	FAILED
Direct pip install in editable mode using tarball URL	INVALID COMMAND (included for completeness)
setup.py install using git URL	FAILED
setup.py install in editable mode using git URL	FAILED
setup.py install using tarball URL	FAILED
setup.py install in editable mode using tarball URL	FAILED

Test Results Using crbunney/uap-python/fix_pip_install_from_source
git URL: git+https://github.com/crbunney/uap-python.git@fix_pip_install_from_source#egg=ua-parser-0.4.0
tarball URL: https://github.com/crbunney/uap-python/tarball/fix_pip_install_from_source#egg=ua-parser-0.4.0

Test Case	Result
Direct pip install using git URL	PASSED
Direct pip install in editable mode using git URL	PASSED
Direct pip install using tarball URL	FAILED (due to the tarball download not included the uap-core submodule)
Direct pip install in editable mode using tarball URL	INVALID COMMAND (included for completeness)
setup.py install using git URL	PASSED
setup.py install in editable mode using git URL	PASSED
setup.py install using tarball URL	FAILED (due to the tarball download not included the uap-core submodule)
setup.py install in editable mode using tarball URL	FAILED (due to the tarball download not included the uap-core submodule)

crbunney · 2015-08-12T12:28:49Z

setup.py

@@ -50,10 +57,12 @@ def run(self):
    url='https://github.com/ua-parser/uap-python',
    include_package_data=True,
    package_data={'ua_parser': ['regexes.yaml', 'regexes.json']},
+    setup_requires=['pyyaml'],
    install_requires=['pyyaml'],


Changing this line from install_requires=['pyyaml'] to tests_require=['pyyaml'] would let users choose not to install pyyaml if they only want to use the parser, since user_agent_parser.py doesn't use pyyaml, but it would still be installed if python setup.py test was run.

The only other pyyaml usage was in the setup.py itself, and I had to add setup_requires to ensure it was available to the setup.py script.

elsigh · 2015-09-21T18:08:32Z

I honestly am happy to merge this though I don't really understand the ramifications of it. I also don't personally use the python version in prod. Can anyone else say anything about this idea? I like the notion of being able to install from github in principle. @selwin ?

elsigh · 2015-10-01T17:43:38Z

Ok, well, in the interest of moving fast and supporting anyone who writes a PR I'm going to merge this. If there are issues, will you please take the lead on fixing them? =() thanks.

Update setup.py to enable pip installs direct from github

move Netfront to prevous place

crbunney · 2015-10-15T16:34:08Z

I'll keep an eye on it, of course :)

crbunney reviewed Aug 12, 2015
View reviewed changes

crbunney changed the title ~~Run install_regexes() for install command as well as sdist and develop~~ Update setup.py to enable pip installs direct from github Aug 12, 2015

Run install_regexes() for install command as well as sdist and develop

1e2a932

elsigh added a commit that referenced this pull request Oct 1, 2015

Merge pull request #12 from crbunney/fix_pip_install_from_source

112eefc

Update setup.py to enable pip installs direct from github

elsigh merged commit 112eefc into ua-parser:master Oct 1, 2015

mattrobenolt mentioned this pull request Oct 11, 2015

Fix install from sdist and bdist_wheel #27

Merged

selwin pushed a commit to selwin/uap-python that referenced this pull request Oct 14, 2015

Merge pull request ua-parser#12 from commenthol/ua-netfront-move

7855e1b

move Netfront to prevous place

crbunney deleted the fix_pip_install_from_source branch October 15, 2015 16:33

crbunney restored the fix_pip_install_from_source branch October 15, 2015 17:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update setup.py to enable pip installs direct from github #12

Update setup.py to enable pip installs direct from github #12

Uh oh!

crbunney commented Aug 11, 2015

Uh oh!

crbunney Aug 12, 2015

Uh oh!

elsigh commented Sep 21, 2015

Uh oh!

elsigh commented Oct 1, 2015

Uh oh!

crbunney commented Oct 15, 2015

Uh oh!

Uh oh!

Update setup.py to enable pip installs direct from github #12

Update setup.py to enable pip installs direct from github #12

Uh oh!

Conversation

crbunney commented Aug 11, 2015

Uh oh!

crbunney Aug 12, 2015

Choose a reason for hiding this comment

Uh oh!

elsigh commented Sep 21, 2015

Uh oh!

elsigh commented Oct 1, 2015

Uh oh!

crbunney commented Oct 15, 2015

Uh oh!

Uh oh!