shotgunsoftware / python-api

A Python-based library for accessing Flow Production Tracking API.
https://developer.shotgridsoftware.com/python-api
Other
306 stars 198 forks source link

Documentation: Deprecated protocol in installation instructions #260

Closed ricekab closed 2 years ago

ricekab commented 2 years ago

Issue

The installation documentation contains a method that is no longer supported. This is the resulting error:

$ pip install git+git://github.com/shotgunsoftware/python-api.git
Collecting git+git://github.com/shotgunsoftware/python-api.git
...
fatal: remote error:
The unauthenticated git protocol on port 9418 is no longer supported.
Please see https://github.blog/2021-09-01-improving-git-protocol-security-github/ for more information

Solution

Installing over https works fine:

$ pip install git+https://github.com/shotgunsoftware/python-api.git
Collecting git+https://github.com/shotgunsoftware/python-api.git
...
Building wheels for collected packages: shotgun-api3
  Building wheel for shotgun-api3 (setup.py) ... done
  Created wheel for shotgun-api3: filename=shotgun_api3-3.3.3-py3-none-any.whl size=495076 sha256=7b85ce0030933099890695744157c7750e8532323fe5fc127d2dff959787d465
...
Successfully installed shotgun-api3-3.3.3

References

GitHub blog post detailing deprecation: https://github.blog/2021-09-01-improving-git-protocol-security-github/

ricekab commented 2 years ago

Fixed in #262 . Withdrawing PR #261