Update links in documentation

The canonical Pipenv documentation is now at pipenv.pypa.io. Also, the canonical GitHub repositories for Pipenv and Requests have changed, and some other communications links (Twitter, mailing list, "thank you") were no longer operational. This commit updates those and clarifies that Pipenv is a project maintained by the PyPA. Fixes pypa#4137. Signed-off-by: Sumana Harihareswara <[email protected]>
brainwane · Mar 6, 2020 · 603a20b · 603a20b
1 parent d10b2a2
commit 603a20b
Show file tree

Hide file tree

Showing 16 changed files with 37 additions and 40 deletions.
diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md
@@ -5,7 +5,7 @@ about: Create a report to help us improve
 
 Be sure to check the existing issues (both open and closed!), and make sure you are running the latest version of Pipenv.
 
-Check the [diagnose documentation](https://pipenv.kennethreitz.org/en/latest/diagnose/) for common issues before posting! We may close your issue if it is very similar to one of them. Please be considerate, or be on your way.
+Check the [diagnose documentation](https://pipenv.pypa.io/en/latest/diagnose/) for common issues before posting! We may close your issue if it is very similar to one of them. Please be considerate, or be on your way.
 
 Make sure to mention your debugging experience if the documented solution failed.
 

diff --git a/.gitmodules b/.gitmodules
@@ -6,7 +6,7 @@
 	url = https://github.com/pinax/pinax.git
 [submodule "tests/test_artifacts/git/requests"]
 	path = tests/test_artifacts/git/requests
-	url = https://github.com/kennethreitz/requests.git
+	url = https://github.com/psf/requests.git
 [submodule "tests/test_artifacts/git/six"]
 	path = tests/test_artifacts/git/six
 	url = https://github.com/benjaminp/six.git
@@ -24,7 +24,7 @@
 	url = https://github.com/pallets/flask.git
 [submodule "tests/test_artifacts/git/requests-2.18.4"]
 	path = tests/test_artifacts/git/requests-2.18.4
-	url = https://github.com/kennethreitz/requests
+	url = https://github.com/psf/requests
 [submodule "tests/pypi"]
 	path = tests/pypi
 	url = https://github.com/sarugaku/pipenv-test-artifacts.git
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright 2017 Kenneth Reitz
+Copyright 2020 Python Packaging Authority
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -5,7 +5,6 @@ Pipenv: Python Development Workflow for Humans
 [![image](https://img.shields.io/pypi/l/pipenv.svg)](https://python.org/pypi/pipenv)
 [![Azure Pipelines Build Status](https://dev.azure.com/pypa/pipenv/_apis/build/status/Pipenv%20CI?branchName=master)](https://dev.azure.com/pypa/pipenv/_build/latest?definitionId=16&branchName=master)
 [![image](https://img.shields.io/pypi/pyversions/pipenv.svg)](https://python.org/pypi/pipenv)
-[![image](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/kennethreitz)
 
 ------------------------------------------------------------------------
 
@@ -56,7 +55,7 @@ Or, if you\'re using FreeBSD:
 
     # pkg install py36-pipenv
 
-Otherwise, refer to the [documentation](https://pipenv.kennethreitz.org/en/latest/#install-pipenv-today) for instructions.
+Otherwise, refer to the [documentation](https://pipenv.pypa.io/en/latest/#install-pipenv-today) for instructions.
 
 ✨🍰✨
 
@@ -297,4 +296,4 @@ Use the shell:
 ☤ Documentation
 ---------------
 
-Documentation resides over at [pipenv.org](https://pipenv.kennethreitz.org/en/latest/).
+Documentation resides over at [pipenv.pypa.io](https://pipenv.pypa.io/en/latest/).
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
@@ -37,17 +37,16 @@
 <h3>Stay Informed</h3>
 <p>Receive updates on new releases and upcoming projects.</p>
 
-<p><a href="https://twitter.com/kennethreitz" class="twitter-follow-button" data-show-count="false">Follow @kennethreitz</a> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script></p>
-<p><a href="https://saythanks.io/to/kennethreitz">Say Thanks!</a></p>
-<p><a href="http://tinyletter.com/kennethreitz">Join Mailing List</a>.</p>
+<p><a href="https://twitter.com/ThePyPA" class="twitter-follow-button" data-show-count="false">Follow @ThePyPA</a> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script></p>
+<p><a href="https://mail.python.org/mailman3/lists/distutils-sig.python.org/">Join Mailing List</a>.</p>
 
 <h3>Other Projects</h3>
 
 <ul>
   <li><a href="https://pipenv-pipes.readthedocs.io/en/latest/">Pipenv-Pipes</a></li>
 </ul>
 
-<p>More <a href="http://kennethreitz.org/">Kenneth Reitz</a> projects:</p>
+<p>More projects founded by <a href="http://kennethreitz.org/">Kenneth Reitz</a>:</p>
 <ul>
     <li><a href="http://pep8.org/">pep8.org</a></li>
     <li><a href="http://httpbin.org/">httpbin.org</a></li>

diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
@@ -38,20 +38,19 @@
 <h3>Stay Informed</h3>
 <p>Receive updates on new releases and upcoming projects.</p>
 
-<p><iframe src="https://ghbtns.com/github-btn.html?user=kennethreitz&type=follow&count=true"
+<p><iframe src="https://ghbtns.com/github-btn.html?user=pypa&type=follow&count=true"
   allowtransparency="true" frameborder="0" scrolling="0" width="200" height="20"></iframe></p>
 
-<p><a href="https://twitter.com/kennethreitz" class="twitter-follow-button" data-show-count="false">Follow @kennethreitz</a> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script></p>
-<p><a href="https://saythanks.io/to/kennethreitz">Say Thanks!</a></p>
-<p><a href="http://tinyletter.com/kennethreitz">Join Mailing List</a>.</p>
+<p><a href="https://twitter.com/ThePyPA" class="twitter-follow-button" data-show-count="false">Follow @ThePyPA</a> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script></p>
+<p><a href="https://mail.python.org/mailman3/lists/distutils-sig.python.org/">Join Mailing List</a>.</p>
 
 <h3>Other Projects</h3>
 
 <ul>
   <li><a href="https://pipenv-pipes.readthedocs.io/en/latest/">Pipenv-Pipes</a></li>
 </ul>
 
-<p>More <a href="http://kennethreitz.org/">Kenneth Reitz</a> projects:</p>
+<p>More projects founded by <a href="http://kennethreitz.org/">Kenneth Reitz</a>:</p>
 <ul>
     <li><a href="http://pep8.org/">pep8.org</a></li>
     <li><a href="http://httpbin.org/">httpbin.org</a></li>
@@ -72,9 +71,9 @@ <h3>Useful Links</h3>
   <p></p>
 
   <li><a href="http://github.com/pypa/pipenv">Pipenv @ GitHub</a></li>
-  <li><a href="http://pypi.python.org/pypi/pipenv">Pipenv @ PyPI</a></li>
+  <li><a href="http://pypi.org/project/pipenv">Pipenv @ PyPI</a></li>
   <li><a href="https://launchpad.net/~pypa/+archive/ubuntu/ppa">Pipenv PPA (PyPA)</a></li>
-  <li><a href="http://github.com/kennethreitz/pipenv/issues">Issue Tracker</a></li>
+  <li><a href="http://github.com/pypa/pipenv/issues">Issue Tracker</a></li>
   <hr>
   <li><a href="http://pipenv-ja.readthedocs.io/ja/translate-ja/">日本語</a></li>
   <li><a href="https://pipenv-es.readthedocs.io/es/latest/">Español</a></li>

diff --git a/docs/advanced.rst b/docs/advanced.rst
@@ -20,7 +20,7 @@ This document covers some of Pipenv's more glorious and advanced features.
 If you'd like a specific package to be installed with a specific package index, you can do the following::
 
     [[source]]
-    url = "https://pypi.python.org/simple"
+    url = "https://pypi.org/simple"
     verify_ssl = true
     name = "pypi"
 
@@ -525,7 +525,7 @@ probably a good idea in any case.
 
 A 3rd party plugin, `tox-pipenv`_ is also available to use Pipenv natively with tox.
 
-.. _Requests: https://github.com/kennethreitz/requests
+.. _Requests: https://github.com/psf/requests
 .. _tox: https://tox.readthedocs.io/en/latest/
 .. _tox-pipenv: https://tox-pipenv.readthedocs.io/en/latest/
 .. _Travis-CI: https://travis-ci.org/

diff --git a/docs/conf.py b/docs/conf.py
@@ -57,8 +57,8 @@
 
 # General information about the project.
 project = u'pipenv'
-copyright = u'2017. A <a href="http://kennethreitz.com/pages/open-projects.html">Kenneth Reitz</a> Project'
-author = u'Kenneth Reitz'
+copyright = u'2020. A project founded by <a href="http://kennethreitz.com/pages/open-projects.html">Kenneth Reitz</a>'
+author = u'Python Packaging Authority'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

diff --git a/docs/dev/philosophy.rst b/docs/dev/philosophy.rst
@@ -7,6 +7,8 @@ Pipenv is an open but opinionated tool, created by an open but opinionated devel
 Management Style
 ~~~~~~~~~~~~~~~~
 
+    **To be updated (as of March 2020)**.
+
 `Kenneth Reitz <http://kennethreitz.org>`__ is the BDFL. He has final say in any decision related to the Pipenv project. Kenneth is responsible for the direction and form of the library, as well as its presentation. In addition to making decisions based on technical merit, he is responsible for making decisions based on the development philosophy of Pipenv.
 
 `Dan Ryan <http://github.com/techalchemy>`__, `Tzu-ping Chung <https://github.com/uranusjr>`__, and `Nate Prewitt <https://github.com/nateprewitt>`__ are the core contributors.

diff --git a/docs/index.rst b/docs/index.rst
@@ -15,9 +15,6 @@ Pipenv: Python Dev Workflow for Humans
 .. image:: https://img.shields.io/pypi/pyversions/pipenv.svg
     :target: https://pypi.python.org/pypi/pipenv
 
-.. image:: https://img.shields.io/badge/Say%20Thanks!-🦉-1EAEDB.svg
-    :target: https://saythanks.io/to/kennethreitz
-
 ---------------
 
 **Pipenv** is a tool that aims to bring the best of all packaging worlds (bundler, composer, npm, cargo, yarn, etc.) to the Python world. *Windows is a first-class citizen, in our world.*

diff --git a/docs/install.rst b/docs/install.rst
@@ -146,7 +146,7 @@ To upgrade pipenv at any time::
 
 If you don't even have pip installed, you can use this crude installation method, which will bootstrap your whole system::
 
-    $ curl https://raw.githubusercontent.com/kennethreitz/pipenv/master/get-pipenv.py | python
+    $ curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
 
 
 ☤ Installing packages for your project

diff --git a/news/4137.doc b/news/4137.doc
@@ -0,0 +1 @@
+Updated documentation to point to working links.
diff --git a/pipenv/pipenv.1 b/pipenv/pipenv.1
@@ -275,7 +275,7 @@ If you don\(aqt even have pip installed, you can use this crude installation met
 .sp
 .nf
 .ft C
-$ curl https://raw.githubusercontent.com/kennethreitz/pipenv/master/get\-pipenv.py | python
+$ curl https://raw.githubusercontent.com/pypa/pipenv/master/get\-pipenv.py | python
 .ft P
 .fi
 .UNINDENT
@@ -4121,6 +4121,6 @@ search
 .SH AUTHOR
 Kenneth Reitz
 .SH COPYRIGHT
-2017. A <a href="http://kennethreitz.com/pages/open-projects.html">Kenneth Reitz</a> Project
+2017. A project founded by <a href="http://kennethreitz.com/pages/open-projects.html">Kenneth Reitz</a>
 .\" Generated by docutils manpage writer.
 .
diff --git a/setup.py b/setup.py
@@ -118,8 +118,8 @@ def run(self):
     description="Python Development Workflow for Humans.",
     long_description=long_description,
     long_description_content_type='text/markdown',
-    author="Kenneth Reitz",
-    author_email="me@kennethreitz.org",
+    author="Pipenv maintainer team",
+    author_email="distutils-sig@python.org",
     url="https://github.com/pypa/pipenv",
     packages=find_packages(exclude=["tests", "tests.*", "tasks", "tasks.*"]),
     entry_points={

diff --git a/tests/integration/test_lock.py b/tests/integration/test_lock.py
@@ -174,7 +174,7 @@ def test_complex_lock_with_vcs_deps(PipenvInstance, pip_src_dir):
 click = "==6.7"
 
 [dev-packages]
-requests = {git = "https://github.com/kennethreitz/requests.git"}
+requests = {git = "https://github.com/psf/requests.git"}
             """.strip()
             f.write(contents)
 
@@ -429,7 +429,7 @@ def test_lock_editable_vcs_without_install(PipenvInstance):
         with open(p.pipfile_path, 'w') as f:
             f.write("""
 [packages]
-requests = {git = "https://github.com/kennethreitz/requests.git", ref = "master", editable = true}
+requests = {git = "https://github.com/psf/requests.git", ref = "master", editable = true}
             """.strip())
         c = p.pipenv('lock')
         assert c.return_code == 0
@@ -448,11 +448,11 @@ def test_lock_editable_vcs_with_ref_in_git(PipenvInstance):
         with open(p.pipfile_path, 'w') as f:
             f.write("""
 [packages]
-requests = {git = "https://github.com/kennethreitz/requests.git@883caaf", editable = true}
+requests = {git = "https://github.com/psf/requests.git@883caaf", editable = true}
             """.strip())
         c = p.pipenv('lock')
         assert c.return_code == 0
-        assert p.lockfile['default']['requests']['git'] == 'https://github.com/kennethreitz/requests.git'
+        assert p.lockfile['default']['requests']['git'] == 'https://github.com/psf/requests.git'
         assert p.lockfile['default']['requests']['ref'] == '883caaf145fbe93bd0d208a6b864de9146087312'
         c = p.pipenv('install')
         assert c.return_code == 0
@@ -466,11 +466,11 @@ def test_lock_editable_vcs_with_ref(PipenvInstance):
         with open(p.pipfile_path, 'w') as f:
             f.write("""
 [packages]
-requests = {git = "https://github.com/kennethreitz/requests.git", ref = "883caaf", editable = true}
+requests = {git = "https://github.com/psf/requests.git", ref = "883caaf", editable = true}
             """.strip())
         c = p.pipenv('lock')
         assert c.return_code == 0
-        assert p.lockfile['default']['requests']['git'] == 'https://github.com/kennethreitz/requests.git'
+        assert p.lockfile['default']['requests']['git'] == 'https://github.com/psf/requests.git'
         assert p.lockfile['default']['requests']['ref'] == '883caaf145fbe93bd0d208a6b864de9146087312'
         c = p.pipenv('install')
         assert c.return_code == 0
@@ -485,7 +485,7 @@ def test_lock_editable_vcs_with_extras_without_install(PipenvInstance):
         with open(p.pipfile_path, 'w') as f:
             f.write("""
 [packages]
-requests = {git = "https://github.com/kennethreitz/requests.git", editable = true, extras = ["socks"]}
+requests = {git = "https://github.com/psf/requests.git", editable = true, extras = ["socks"]}
             """.strip())
         c = p.pipenv('lock')
         assert c.return_code == 0
@@ -505,7 +505,7 @@ def test_lock_editable_vcs_with_markers_without_install(PipenvInstance):
         with open(p.pipfile_path, 'w') as f:
             f.write("""
 [packages]
-requests = {git = "https://github.com/kennethreitz/requests.git", ref = "master", editable = true, markers = "python_version >= '2.6'"}
+requests = {git = "https://github.com/psf/requests.git", ref = "master", editable = true, markers = "python_version >= '2.6'"}
             """.strip())
         c = p.pipenv('lock')
         assert c.return_code == 0

diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
@@ -217,14 +217,14 @@ def test_windows_shellquote(self):
 
     @pytest.mark.utils
     def test_is_valid_url(self):
-        url = "https://github.com/kennethreitz/requests.git"
+        url = "https://github.com/psf/requests.git"
         not_url = "something_else"
         assert pipenv.utils.is_valid_url(url)
         assert pipenv.utils.is_valid_url(not_url) is False
 
     @pytest.mark.utils
     def test_download_file(self):
-        url = "https://github.com/kennethreitz/pipenv/blob/master/README.md"
+        url = "https://github.com/pypa/pipenv/blob/master/README.md"
         output = "test_download.md"
         pipenv.utils.download_file(url, output)
         assert os.path.exists(output)