How to install git+https:// from setup.py using install_requires

Question

I have a project in which I have to install from git+https:

I can make it to work in this way:

virtualenv -p python3.5 bla
. bla/bin/activate
pip install numpy # must have numpy before the following pkg...
pip install 'git+https://github.com/cocodataset/cocoapi.git#subdirectory=PythonAPI'

However, I want to use it in a setup.py file in install_requires:

from setuptools import setup
setup(install_requires='git+https://github.com/cocodataset/cocoapi.git#subdirectory=PythonAPI', setup_requires='numpy')

and then, pip install -e . from the dir containing the setup.py

This doesn't work due to parse error:

    Complete output (1 lines):                                                                                                             
    error in bla_bla setup command: 'install_requires' must be a string or list of strings containing valid project/version requireme
nt specifiers; Invalid requirement, parse error at "'+https:/'"                                                                             
    ----------------------------------------
ERROR: Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.

The error doesn't occur if I install using pip install -r requires.txt (assuming I have the same string in that file) and not when using direct pip install git+......

How to fix this parsing error?

What I've tried so far:

wrapping the string with " / """ / ' / '''
adding 'r' before the string

Does this answer your question? How to write setup.py to include a git repo as a dependency — Bram Vanroy
– Bram Vanroy, Commented Feb 26, 2020 at 13:53
@BramVanroy dependency_links were declared obsolete and finally removed in pip 19.0. Please retract your vote. — phd
– phd, Commented Feb 26, 2020 at 15:45
@phd It's the same core question, though, and answers on the duplicate question also answer this one (stackoverflow.com/a/54794506/1150683). — Bram Vanroy
– Bram Vanroy, Commented Feb 26, 2020 at 16:10
@phd Updated this question to be specific about install_requires to better distinguish the questions and retracted my vote. — Bram Vanroy
– Bram Vanroy, Commented Feb 26, 2020 at 16:14

ZachB · Accepted Answer · 2022-09-23 23:13:53Z

27

install_requires must be a string or a list of strings with names and optionally URLs to get the package from:

install_requires=[
    'pycocotools @ git+https://github.com/cocodataset/cocoapi.git#subdirectory=PythonAPI'
]

See https://pip.pypa.io/en/stable/reference/requirement-specifiers/ and https://www.python.org/dev/peps/pep-0440/#direct-references

This requires pip install including pip install . and doesn't work with python setup.py install.

edited Sep 23, 2022 at 23:13

ZachB

15.8k5 gold badges67 silver badges94 bronze badges

answered Feb 26, 2020 at 13:53

phd

97.2k14 gold badges165 silver badges223 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

sinoroc Over a year ago

I'll add this reference for the python setup.py install vs. pip install . part: comment from pganssle in the discussion "Setuptools install fails with PEP508 URLs" in setuptools's issue tracker: "Our policy to date has been that if using pip install fixes your problem, you should use pip install and we won't fix the issue"

CIsForCookies Over a year ago

That sucks, because there is an inconsistency between pip install "pkg_name" / pip install -r <requirements_file> and pip install -e .. Thanks anyway!

sinoroc Over a year ago

@ClsForCookies What is the inconsistency? I believe if all the requirements follow PEP 508 and setup.py is not called directly then it should be consistent.

Prince Mathur Over a year ago

Can you tell what role does this part play in the command? #subdirectory=PythonAPI

Collectives™ on Stack Overflow

How to install git+https:// from setup.py using install_requires

1 Answer 1

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related