summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSeth Michael Larson <sethmichaellarson@gmail.com>2020-08-02 00:08:12 -0500
committerNate Prewitt <nate.prewitt@gmail.com>2020-08-18 15:13:59 -0700
commit551a0bf0df2db42413baf4734ad6be37415f25ca (patch)
treef2410d81a6cac66475b7d2a8b0178bd22f647ec9
parent08300621004a76dcacf03ed6538bcf2e592ac521 (diff)
downloadpython-requests-551a0bf0df2db42413baf4734ad6be37415f25ca.tar.gz
Recommend Pip, remove todo/philo docs, pare down support avenues
-rw-r--r--docs/community/support.rst30
-rw-r--r--docs/dev/contributing.rst12
-rw-r--r--docs/dev/philosophy.rst45
-rw-r--r--docs/dev/todo.rst62
-rw-r--r--docs/index.rst3
-rw-r--r--docs/user/advanced.rst2
-rw-r--r--docs/user/install.rst12
-rw-r--r--docs/user/intro.rst45
8 files changed, 8 insertions, 203 deletions
diff --git a/docs/community/support.rst b/docs/community/support.rst
index b7c08762..18168d0e 100644
--- a/docs/community/support.rst
+++ b/docs/community/support.rst
@@ -13,14 +13,6 @@ information or can be properly anonymized, please ask a question on
`Stack Overflow <https://stackoverflow.com/questions/tagged/python-requests>`_
and use the tag ``python-requests``.
-Send a Tweet
-------------
-
-If your question is less than 280 characters, feel free to send a tweet to
-`@kennethreitz <https://twitter.com/kennethreitz>`_,
-`@sigmavirus24 <https://twitter.com/sigmavirus24>`_,
-`@lukasaoz <https://twitter.com/lukasaoz>`_, or
-`@nateprewitt <https://twitter.com/nateprewitt>`_.
File an Issue
-------------
@@ -28,25 +20,3 @@ File an Issue
If you notice some unexpected behaviour in Requests, or want to see support
for a new feature,
`file an issue on GitHub <https://github.com/psf/requests/issues>`_.
-
-
-E-mail
-------
-
-I'm more than happy to answer any personal or in-depth questions about
-Requests. Feel free to email
-`requests@kennethreitz.com <mailto:requests@kennethreitz.com>`_.
-
-
-IRC
----
-
-The official Freenode channel for Requests is
-`#python-requests <irc://irc.freenode.net/python-requests>`_
-
-The core developers of requests are on IRC throughout the day.
-You can find them in ``#python-requests`` as:
-
-- kennethreitz
-- lukasa
-- sigmavirus24
diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst
index 0294c4ce..6b1cef7b 100644
--- a/docs/dev/contributing.rst
+++ b/docs/dev/contributing.rst
@@ -11,23 +11,17 @@ contributing to the Requests project is *very* generous of you.
This document lays out guidelines and advice for contributing to this project.
If you're thinking of contributing, please start by reading this document and
getting a feel for how contributing to this project works. If you have any
-questions, feel free to reach out to either `Ian Cordasco`_, `Cory Benfield`_,
-or `Nate Prewitt`_, the primary maintainers.
+questions, feel free to reach out to either `Nate Prewitt`_, `Ian Cordasco`_,
+or `Seth Michael Larson`_, the primary maintainers.
.. _Ian Cordasco: http://www.coglib.com/~icordasc/
-.. _Cory Benfield: https://lukasa.co.uk/about
.. _Nate Prewitt: https://www.nateprewitt.com/
-
-If you have non-technical feedback, philosophical ponderings, crazy ideas, or
-other general thoughts about Requests or its position within the Python
-ecosystem, the BDFL, `Kenneth Reitz`_, would love to hear from you.
+.. _Seth Michael Larson: https://sethmlarson.dev/
The guide is split into sections based on the type of contribution you're
thinking of making, with a section that covers general guidelines for all
contributors.
-.. _Kenneth Reitz: mailto:me@kennethreitz.org
-
Be Cordial
----------
diff --git a/docs/dev/philosophy.rst b/docs/dev/philosophy.rst
deleted file mode 100644
index 5f8f3022..00000000
--- a/docs/dev/philosophy.rst
+++ /dev/null
@@ -1,45 +0,0 @@
-Development Philosophy
-======================
-
-Requests is an open but opinionated library, created by an open but opinionated developer.
-
-
-Management Style
-~~~~~~~~~~~~~~~~
-
-`Kenneth Reitz <https://www.kennethreitz.org/>`_ is the BDFL. He has final say in any decision related to the Requests 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 Requests.
-
-`Ian Cordasco <http://www.coglib.com/~icordasc/>`_, `Cory Benfield <https://lukasa.co.uk/about/>`_, and `Nate Prewitt <https://www.nateprewitt.com/>`_ are the core contributors. They are responsible for triaging bug reports, reviewing pull requests and ensuring that Kenneth is kept up to speed with developments around the library. The day-to-day managing of the project is done by the core contributors. They are responsible for making judgements about whether or not a feature request is likely to be accepted by Kenneth. Their word is, in some ways, more final than Kenneth's.
-
-Values
-~~~~~~
-
-- Simplicity is always better than functionality.
-- Listen to everyone, then disregard it.
-- The API is all that matters. Everything else is secondary.
-- Fit the 90% use-case. Ignore the nay-sayers.
-
-Semantic Versioning
-~~~~~~~~~~~~~~~~~~~
-
-For many years, the open source community has been plagued with version number dystonia. Numbers vary so greatly from project to project, they are practically meaningless.
-
-Requests uses `Semantic Versioning <https://semver.org/>`_. This specification seeks to put an end to this madness with a small set of practical guidelines for you and your colleagues to use in your next project.
-
-Standard Library?
-~~~~~~~~~~~~~~~~~
-
-Requests has no *active* plans to be included in the standard library. This decision has been discussed at length with Guido as well as numerous core developers.
-
-.. raw:: html
-
- <script async class="speakerdeck-embed" data-id="68f22f0841734d848315c618111b13ea" data-ratio="1.33333333333333" src="//speakerdeck.com/assets/embed.js"></script>
-
-Essentially, the standard library is where a library goes to die. It is appropriate for a module to be included when active development is no longer necessary.
-
-Linux Distro Packages
-~~~~~~~~~~~~~~~~~~~~~
-
-Distributions have been made for many Linux repositories, including: Ubuntu, Debian, RHEL, and Arch.
-
-These distributions are sometimes divergent forks, or are otherwise not kept up-to-date with the latest code and bugfixes. PyPI (and its mirrors) and GitHub are the official distribution sources; alternatives are not supported by the Requests project.
diff --git a/docs/dev/todo.rst b/docs/dev/todo.rst
deleted file mode 100644
index 5347d9e2..00000000
--- a/docs/dev/todo.rst
+++ /dev/null
@@ -1,62 +0,0 @@
-How to Help
-===========
-
-Requests is under active development, and contributions are more than welcome!
-
-#. Check for open issues or open a fresh issue to start a discussion around a bug.
- There is a Contributor Friendly tag for issues that should be ideal for people who are not very
- familiar with the codebase yet.
-#. Fork `the repository <https://github.com/psf/requests>`_ on GitHub and start making your
- changes to a new branch.
-#. Write a test which shows that the bug was fixed.
-#. Send a pull request and bug the maintainer until it gets merged and published. :)
- Make sure to add yourself to `AUTHORS <https://github.com/psf/requests/blob/master/AUTHORS.rst>`_.
-
-Feature Freeze
---------------
-
-As of v1.0.0, Requests has now entered a feature freeze. Requests for new
-features and Pull Requests implementing those features will not be accepted.
-
-Development Dependencies
-------------------------
-
-You'll need to install py.test in order to run the Requests' test suite::
-
- $ venv .venv
- $ source .venv/bin/activate
-
- $ make
- $ python setup.py test
- ============================= test session starts ==============================
- platform darwin -- Python 3.4.4, pytest-3.0.6, py-1.4.32, pluggy-0.4.0
- ...
- collected 445 items
-
- tests/test_hooks.py ...
- tests/test_lowlevel.py ............
- tests/test_requests.py ...........................................................
- tests/test_structures.py ....................
- tests/test_testserver.py ...........
- tests/test_utils.py ..s...........................................................
-
- ============== 442 passed, 1 skipped, 2 xpassed in 46.48 seconds ===============
-
-You can also run ``$ make tests`` to run against all supported Python versions, using tox/detox.
-
-Runtime Environments
---------------------
-
-Requests currently supports the following versions of Python:
-
-- Python 2.7
-- Python 3.4
-- Python 3.5
-- Python 3.6
-- Python 3.7
-- PyPy
-
-Google App Engine is not officially supported although support is available
-with the `Requests-Toolbelt`_.
-
-.. _Requests-Toolbelt: https://toolbelt.readthedocs.io/
diff --git a/docs/index.rst b/docs/index.rst
index d05f33d5..b61acfc1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -81,7 +81,6 @@ instructions for getting the most out of Requests.
.. toctree::
:maxdepth: 2
- user/intro
user/install
user/quickstart
user/advanced
@@ -127,8 +126,6 @@ you.
:maxdepth: 3
dev/contributing
- dev/philosophy
- dev/todo
dev/authors
There are no more guides. You are now guideless.
diff --git a/docs/user/advanced.rst b/docs/user/advanced.rst
index cb6967c3..42f28854 100644
--- a/docs/user/advanced.rst
+++ b/docs/user/advanced.rst
@@ -628,7 +628,7 @@ You can get the dependencies for this feature from ``pip``:
.. code-block:: bash
- $ pip install requests[socks]
+ $ python -m pip install requests[socks]
Once you've installed those dependencies, using a SOCKS proxy is just as easy
as using a HTTP one::
diff --git a/docs/user/install.rst b/docs/user/install.rst
index cb9f2512..ed205dbc 100644
--- a/docs/user/install.rst
+++ b/docs/user/install.rst
@@ -7,16 +7,12 @@ This part of the documentation covers the installation of Requests.
The first step to using any software package is getting it properly installed.
-$ pipenv install requests
--------------------------
+$ python -m pip install requests
+--------------------------------
To install Requests, simply run this simple command in your terminal of choice::
- $ pipenv install requests
-
-If you don't have `pipenv <https://pipenv.kennethreitz.org>`_ installed (tisk tisk!), head over to the Pipenv website for installation instructions. Or, if you prefer to just use pip and don't have it installed,
-`this Python installation guide <https://docs.python-guide.org/starting/installation/>`_
-can guide you through the process.
+ $ python -m pip install requests
Get the Source Code
-------------------
@@ -37,4 +33,4 @@ Once you have a copy of the source, you can embed it in your own Python
package, or install it into your site-packages easily::
$ cd requests
- $ pip install .
+ $ python -m pip install .
diff --git a/docs/user/intro.rst b/docs/user/intro.rst
deleted file mode 100644
index 3f7b5417..00000000
--- a/docs/user/intro.rst
+++ /dev/null
@@ -1,45 +0,0 @@
-.. _introduction:
-
-Introduction
-============
-
-Philosophy
-----------
-
-Requests was developed with a few :pep:`20` idioms in mind.
-
-
-#. Beautiful is better than ugly.
-#. Explicit is better than implicit.
-#. Simple is better than complex.
-#. Complex is better than complicated.
-#. Readability counts.
-
-All contributions to Requests should keep these important rules in mind.
-
-.. _`apache2`:
-
-Apache2 License
----------------
-
-A large number of open source projects you find today are `GPL Licensed`_.
-While the GPL has its time and place, it should most certainly not be your
-go-to license for your next open source project.
-
-A project that is released as GPL cannot be used in any commercial product
-without the product itself also being offered as open source.
-
-The MIT, BSD, ISC, and Apache2 licenses are great alternatives to the GPL
-that allow your open-source software to be used freely in proprietary,
-closed-source software.
-
-Requests is released under terms of `Apache2 License`_.
-
-.. _`GPL Licensed`: https://opensource.org/licenses/gpl-license.php
-.. _`Apache2 License`: https://opensource.org/licenses/Apache-2.0
-
-
-Requests License
-----------------
-
- .. include:: ../../LICENSE