From 6711e7fde14d02ec3e881a1636eed04bcd0bdc56 Mon Sep 17 00:00:00 2001
From: Adam Nelson
Date: Mon, 14 Mar 2016 12:33:49 -0400
Subject: [PATCH 001/471] Removed references to Setuptools/easy_install in
favor of pip. A new Python user hardly needs to know that easy_install ever
existed
---
docs/starting/install/osx.rst | 44 ++++++++++++++++-------------------
1 file changed, 20 insertions(+), 24 deletions(-)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index cb0062cc7..db029822b 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -5,11 +5,11 @@ Installing Python on Mac OS X
The latest version of Mac OS X, El Capitan, **comes with Python 2.7 out of the box**.
-You do not need to install or configure anything else to use Python. Having
-said that, I would strongly recommend that you install the tools and libraries
-described in the next section before you start building Python applications
-for real-world use. In particular, you should always install Setuptools, as it
-makes it much easier for you to use other third-party Python libraries.
+You do not need to install or configure anything else to use Python. Having said
+that, I would strongly recommend that you install the tools and libraries
+described in the next section before you start building Python applications for
+real-world use. In particular, you should always install ``pip``, as it makes
+it much easier for you to install and manage other third-party Python libraries.
The version of Python that ships with OS X is great for learning but it's not
good for development. The version shipped with OS X may be out of date from the
@@ -33,11 +33,11 @@ package.
diagnose.
.. note::
- If you perform a fresh install of XCode, you will also need to add the
+ If you perform a fresh install of XCode, you will also need to add the
commandline tools by running ``xcode-select --install`` on the terminal.
While OS X comes with a large number of UNIX utilities, those familiar with
-Linux systems will notice one key component missing: a decent package manager.
+Linux systems will notice one key component missing: a package manager.
`Homebrew `_ fills this void.
To `install Homebrew `_, open :file:`Terminal` or
@@ -63,37 +63,33 @@ Now, we can install Python 2.7:
$ brew install python
-This will take a minute or two.
+This will take a minute or two.
-Setuptools & Pip
+Pip
----------------
-Homebrew installs Setuptools and ``pip`` for you.
+Homebrew installs ``pip`` for you.
-Setuptools enables you to download and install any compliant Python
-software over a network (usually the Internet) with a single command
-(``easy_install``). It also enables you to add this network installation
-capability to your own Python software with very little work.
-
-``pip`` is a tool for easily installing and managing Python packages,
-that is recommended over ``easy_install``. It is superior to ``easy_install`` in `several ways `_,
+``pip`` is a tool for easily installing and managing Python packages, that is
+recommended over the deprecated ``easy_install``. It is superior to
+``easy_install`` in `several ways
+`_,
and is actively maintained.
Virtual Environments
--------------------
-A Virtual Environment is a tool to keep the dependencies required by different projects
-in separate places, by creating virtual Python environments for them. It solves the
-"Project X depends on version 1.x but, Project Y needs 4.x" dilemma, and keeps
+A Virtual Environment (commonly referred to as a 'virtualenv') is a tool to keep the dependencies required by different projects
+in separate places, by creating virtual Python environments for them. It solves the
+"Project X depends on version 1.x but, Project Y needs 4.x" dilemma, and keeps
your global site-packages directory clean and manageable.
-For example, you can work on a project which requires Django 1.3 while also
-maintaining a project which requires Django 1.0.
-
-To start using this and see more information: :ref:`Virtual Environments ` docs.
+For example, you can work on a project which requires Django 1.10 while also
+maintaining a project which requires Django 1.7.
+To start using this and see more information: :ref:`Virtual Environments ` docs.
--------------------------------
From 304728846623c831fa549c40c60b1329c99a1264 Mon Sep 17 00:00:00 2001
From: Adam Nelson
Date: Mon, 14 Mar 2016 13:22:14 -0400
Subject: [PATCH 002/471] Removed references to main install page
---
docs/starting/installation.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/starting/installation.rst b/docs/starting/installation.rst
index 04aaaa0b8..c0118f68c 100644
--- a/docs/starting/installation.rst
+++ b/docs/starting/installation.rst
@@ -7,14 +7,14 @@ If so, you do not need to install or configure anything else to use Python.
Having said that, I would strongly recommend that you install the tools and
libraries described in the guides below before you start building Python
applications for real-world use. In particular, you should always install
-Setuptools, Pip, and Virtualenv — they make it much easier for you to use
+Pip, and Virtualenv — they make it much easier for you to use
other third-party Python libraries.
Installation Guides
-------------------
These guides go over the proper installation of :ref:`Python 2.7 `
-for development purposes, as well as setuptools, pip, and virtualenv setup.
+for development purposes, as well as pip and virtualenv.
- :ref:`Mac OS X `.
- :ref:`Microsoft Windows `.
From 8da905eae316c897bc61ffbc9d093483f6341519 Mon Sep 17 00:00:00 2001
From: Adam Nelson
Date: Mon, 14 Mar 2016 14:28:01 -0400
Subject: [PATCH 003/471] First stab at Python3 OS X docs
---
docs/dev/virtualenvs.rst | 35 ++++++----
docs/starting/install/osx.rst | 3 +
docs/starting/install3/osx.rst | 116 +++++++++++++++++++++++++++++++++
docs/starting/installation.rst | 10 +--
4 files changed, 146 insertions(+), 18 deletions(-)
create mode 100644 docs/starting/install3/osx.rst
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index bb3f9487c..90c7f19df 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -8,15 +8,22 @@ projects in separate places, by creating virtual Python environments for them.
It solves the "Project X depends on version 1.x but, Project Y needs 4.x"
dilemma, and keeps your global site-packages directory clean and manageable.
-For example, you can work on a project which requires Django 1.3 while also
-maintaining a project which requires Django 1.0.
+For example, you can work on a project which requires Django 1.9 while also
+maintaining a project which requires Django 1.8.
+
+If you are using Python 3, make sure you run something like the following (or
+have it in your env variables in `~/.bashrc`):
+
+.. code-block:: console
+
+ $ export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python3
virtualenv
----------
`virtualenv `_ is a tool to create
-isolated Python environments. virtualenv creates a folder which contains all the
-necessary executables to use the packages that a Python project would need.
+isolated Python environments. virtualenv creates a folder which contains all the
+necessary executables to use the packages that a Python project would need.
Install virtualenv via pip:
@@ -43,13 +50,13 @@ in the current directory instead.
This creates a copy of Python in whichever directory you ran the command in,
placing it in a folder named :file:`venv`.
-You can also use a Python interpreter of your choice.
+You can also use the Python interpreter of your choice.
.. code-block:: console
- $ virtualenv -p /usr/bin/python2.7 venv
+ $ virtualenv -p /usr/local/bin/python3 venv
-This will use the Python interpreter in :file:`/usr/bin/python2.7`
+This will use the Python interpreter in :file:`/usr/local/bin/python3`
2. To begin using the virtual environment, it needs to be activated:
@@ -57,9 +64,9 @@ This will use the Python interpreter in :file:`/usr/bin/python2.7`
$ source venv/bin/activate
-The name of the current virtual environment will now appear on the left of
-the prompt (e.g. ``(venv)Your-Computer:your_project UserName$)`` to let you know
-that it's active. From now on, any package that you install using pip will be
+The name of the current virtual environment will now appear on the left of
+the prompt (e.g. ``(venv)Your-Computer:your_project UserName$)`` to let you know
+that it's active. From now on, any package that you install using pip will be
placed in the ``venv`` folder, isolated from the global Python installation.
Install packages as usual, for example:
@@ -78,7 +85,7 @@ Install packages as usual, for example:
This puts you back to the system's default Python interpreter with all its
installed libraries.
-To delete a virtual environment, just delete its folder. (In this case,
+To delete a virtual environment, just delete its folder. (In this case,
it would be ``rm -rf venv``.)
After a while, though, you might end up with a lot of virtual environments
@@ -102,8 +109,8 @@ the current state of the environment packages. To do this, run
This will create a :file:`requirements.txt` file, which contains a simple
list of all the packages in the current environment, and their respective
-versions. You can see the list of installed packages without the requirements
-format using "pip list". Later it will be easier for a different developer
+versions. You can see the list of installed packages without the requirements
+format using "pip list". Later it will be easier for a different developer
(or you, if you need to re-create the environment) to install the same packages
using the same versions:
@@ -143,7 +150,7 @@ To install (make sure **virtualenv** is already installed):
.. code-block:: console
$ pip install virtualenvwrapper-win
-
+
In Windows, the default path for WORKON_HOME is %USERPROFILE%\Envs
Basic Usage
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index db029822b..549b8063f 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -3,6 +3,9 @@
Installing Python on Mac OS X
=============================
+.. note::
+ Check out our :ref:`guide for installing Python 3 on OS X`.
+
The latest version of Mac OS X, El Capitan, **comes with Python 2.7 out of the box**.
You do not need to install or configure anything else to use Python. Having said
diff --git a/docs/starting/install3/osx.rst b/docs/starting/install3/osx.rst
new file mode 100644
index 000000000..d5a33291c
--- /dev/null
+++ b/docs/starting/install3/osx.rst
@@ -0,0 +1,116 @@
+.. _install3-osx:
+
+Installing Python 3 on Mac OS X
+================================
+
+The latest version of Mac OS X, El Capitan, **comes with Python 2.7 out of the box**.
+
+You do not need to install or configure anything else to use Python 2. These
+instructions document the installation of Python 3.
+
+The version of Python that ships with OS X is great for learning but it's not
+good for development. The version shipped with OS X may be out of date from the
+`official current Python release `_,
+which is considered the stable production version.
+
+Doing it Right
+--------------
+
+Let's install a real version of Python.
+
+Before installing Python, you'll need to install GCC. GCC can be obtained
+by downloading `XCode `_, the smaller
+`Command Line Tools `_ (must have an
+Apple account) or the even smaller `OSX-GCC-Installer `_
+package.
+
+.. note::
+ If you already have XCode installed, do not install OSX-GCC-Installer.
+ In combination, the software can cause issues that are difficult to
+ diagnose.
+
+.. note::
+ If you perform a fresh install of XCode, you will also need to add the
+ commandline tools by running ``xcode-select --install`` on the terminal.
+
+While OS X comes with a large number of UNIX utilities, those familiar with
+Linux systems will notice one key component missing: a package manager.
+`Homebrew `_ fills this void.
+
+To `install Homebrew `_, open :file:`Terminal` or
+your favorite OSX terminal emulator and run
+
+.. code-block:: console
+
+ $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+The script will explain what changes it will make and prompt you before the
+installation begins.
+Once you've installed Homebrew, insert the Homebrew directory at the top
+of your :envvar:`PATH` environment variable. You can do this by adding the following
+line at the bottom of your :file:`~/.profile` file
+
+.. code-block:: console
+
+ export PATH=/usr/local/bin:/usr/local/sbin:$PATH
+
+Now, we can install Python 3:
+
+.. code-block:: console
+
+ $ brew install python3
+
+This will take a minute or two.
+
+
+Pip
+----------------
+
+Homebrew installs ``pip3`` for you.
+
+``pip3`` is the alias for the Python 3 version of ``pip`` on systems with both
+the Homebrew'd Python 2 and 3 installed.
+
+Working with Python3
+--------------------
+
+At this point, you have the system Python 2.7 available, potentially the
+:ref:`Homebrew version of Python 2 ` installed, and the Homebrew
+version of Python 3 as well.
+
+.. code-block:: console
+
+ $ python
+
+will launch the Python 2 interpreter.
+
+.. code-block:: console
+
+ $ python3
+
+will launch the Python 3 interpreter
+
+``pip3`` and ``pip`` will both be available. If the Homebrew version of Python
+2 is not installed, they will be the same. If the Homebrew version of Python 2
+is installed then ``pip`` will point to Python 2 and ``pip3`` will point to
+Python 3.
+
+
+Virtual Environments
+--------------------
+
+A Virtual Environment (commonly referred to as a 'virtualenv') is a tool to keep
+the dependencies required by different projects in separate places, by creating
+virtual Python environments for them. It solves the "Project X depends on
+version 1.x but, Project Y needs 4.x" dilemma, and keeps your global
+site-packages directory clean and manageable.
+
+For example, you can work on a project which requires Django 1.10 while also
+maintaining a project which requires Django 1.8.
+
+To start using this and see more information: :ref:`Virtual Environments ` docs.
+
+--------------------------------
+
+This page is a remixed version of `another guide `_,
+which is available under the same license.
diff --git a/docs/starting/installation.rst b/docs/starting/installation.rst
index c0118f68c..3c747bf03 100644
--- a/docs/starting/installation.rst
+++ b/docs/starting/installation.rst
@@ -13,9 +13,11 @@ other third-party Python libraries.
Installation Guides
-------------------
-These guides go over the proper installation of :ref:`Python 2.7 `
+These guides go over the proper installation of :ref:`Python `
for development purposes, as well as pip and virtualenv.
-- :ref:`Mac OS X `.
-- :ref:`Microsoft Windows `.
-- :ref:`Ubuntu Linux `.
+- :ref:`Python 3 on Mac OS X `.
+
+- :ref:`Python 2 on Mac OS X `.
+- :ref:`Python 2 on Microsoft Windows `.
+- :ref:`Python 2 on Ubuntu Linux `.
From 53a249a58ec90c04e92247c1fc22a2b69135062b Mon Sep 17 00:00:00 2001
From: Adam Nelson
Date: Tue, 15 Mar 2016 09:47:32 -0400
Subject: [PATCH 004/471] Bad tick marks in virtualenv doc
---
docs/dev/virtualenvs.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index 90c7f19df..37841e214 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -12,7 +12,7 @@ For example, you can work on a project which requires Django 1.9 while also
maintaining a project which requires Django 1.8.
If you are using Python 3, make sure you run something like the following (or
-have it in your env variables in `~/.bashrc`):
+have it in your env variables in ``~/.bashrc``):
.. code-block:: console
From 9223381e4e695968931fa5f684cb5dafe2452593 Mon Sep 17 00:00:00 2001
From: Adam Nelson
Date: Tue, 15 Mar 2016 10:00:26 -0400
Subject: [PATCH 005/471] Python3 stuff in virtualenv less prominent
---
docs/dev/virtualenvs.rst | 16 +++++++---------
1 file changed, 7 insertions(+), 9 deletions(-)
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index 37841e214..ee05a1343 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -11,13 +11,6 @@ dilemma, and keeps your global site-packages directory clean and manageable.
For example, you can work on a project which requires Django 1.9 while also
maintaining a project which requires Django 1.8.
-If you are using Python 3, make sure you run something like the following (or
-have it in your env variables in ``~/.bashrc``):
-
-.. code-block:: console
-
- $ export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python3
-
virtualenv
----------
@@ -50,13 +43,18 @@ in the current directory instead.
This creates a copy of Python in whichever directory you ran the command in,
placing it in a folder named :file:`venv`.
-You can also use the Python interpreter of your choice.
+You can also use the Python interpreter of your choice (like
+:file:`/usr/local/bin/python3`).
.. code-block:: console
$ virtualenv -p /usr/local/bin/python3 venv
-This will use the Python interpreter in :file:`/usr/local/bin/python3`
+or change the interpreter globally with an env variable in ``~/.bashrc``:
+
+.. code-block:: console
+
+ $ export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python3
2. To begin using the virtual environment, it needs to be activated:
From 328a261c4fd30a9f66690d6c94bd9466a1abb66a Mon Sep 17 00:00:00 2001
From: Adam Nelson
Date: Thu, 31 Mar 2016 09:37:57 -0400
Subject: [PATCH 006/471] Re-instated references to setuptools
---
docs/dev/virtualenvs.rst | 6 +++---
docs/starting/install/osx.rst | 15 ++++++++++-----
docs/starting/installation.rst | 5 ++---
3 files changed, 15 insertions(+), 11 deletions(-)
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index ee05a1343..fa0bbfc8c 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -44,17 +44,17 @@ This creates a copy of Python in whichever directory you ran the command in,
placing it in a folder named :file:`venv`.
You can also use the Python interpreter of your choice (like
-:file:`/usr/local/bin/python3`).
+:file:`/usr/bin/python2.7`).
.. code-block:: console
- $ virtualenv -p /usr/local/bin/python3 venv
+ $ virtualenv -p /usr/bin/python2.7 venv
or change the interpreter globally with an env variable in ``~/.bashrc``:
.. code-block:: console
- $ export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python3
+ $ export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python2.7
2. To begin using the virtual environment, it needs to be activated:
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index ae3f10aea..4ffba8648 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -11,7 +11,7 @@ The latest version of Mac OS X, El Capitan, **comes with Python 2.7 out of the b
You do not need to install or configure anything else to use Python. Having said
that, I would strongly recommend that you install the tools and libraries
described in the next section before you start building Python applications for
-real-world use. In particular, you should always install ``pip``, as it makes
+real-world use. In particular, you should always install Setuptools, as it makes
it much easier for you to install and manage other third-party Python libraries.
The version of Python that ships with OS X is great for learning but it's not
@@ -40,7 +40,7 @@ package.
commandline tools by running ``xcode-select --install`` on the terminal.
While OS X comes with a large number of UNIX utilities, those familiar with
-Linux systems will notice one key component missing: a package manager.
+Linux systems will notice one key component missing: a decent package manager.
`Homebrew `_ fills this void.
To `install Homebrew `_, open :file:`Terminal` or
@@ -69,13 +69,18 @@ Now, we can install Python 2.7:
This will take a minute or two.
-Pip
+Setuptools and Pip
----------------
-Homebrew installs ``pip`` for you.
+Homebrew installs Setuptools and ``pip`` for you.
+
+Setuptools enables you to download and install any compliant Python
+ -software over a network (usually the Internet) with a single command
+ -(``easy_install``). It also enables you to add this network installation
+ -capability to your own Python software with very little work.
``pip`` is a tool for easily installing and managing Python packages, that is
-recommended over the deprecated ``easy_install``. It is superior to
+recommended over ``easy_install``. It is superior to
``easy_install`` in `several ways
`_,
and is actively maintained.
diff --git a/docs/starting/installation.rst b/docs/starting/installation.rst
index 3c747bf03..46b9fe4eb 100644
--- a/docs/starting/installation.rst
+++ b/docs/starting/installation.rst
@@ -7,17 +7,16 @@ If so, you do not need to install or configure anything else to use Python.
Having said that, I would strongly recommend that you install the tools and
libraries described in the guides below before you start building Python
applications for real-world use. In particular, you should always install
-Pip, and Virtualenv — they make it much easier for you to use
+Setuptools, Pip, and Virtualenv — they make it much easier for you to use
other third-party Python libraries.
Installation Guides
-------------------
These guides go over the proper installation of :ref:`Python `
-for development purposes, as well as pip and virtualenv.
+for development purposes, as well as setuptools, pip and virtualenv.
- :ref:`Python 3 on Mac OS X `.
-
- :ref:`Python 2 on Mac OS X `.
- :ref:`Python 2 on Microsoft Windows `.
- :ref:`Python 2 on Ubuntu Linux `.
From 4fb3bf7b4a9638ce7d69cb4bde6bcfaf543710c2 Mon Sep 17 00:00:00 2001
From: Michael Bryan
Date: Sun, 12 Jun 2016 19:51:46 +0800
Subject: [PATCH 007/471] Wrote a bit about docstrings
---
docs/writing/documentation.rst | 120 +++++++++++++++++++++++++++++++++
1 file changed, 120 insertions(+)
diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst
index bd59437e8..cb541e13c 100644
--- a/docs/writing/documentation.rst
+++ b/docs/writing/documentation.rst
@@ -65,6 +65,11 @@ There is also **great**, **free** hosting for your Sphinx_ docs:
your source repository so that rebuilding your documentation will
happen automatically.
+When run, Sphinx_ will import your code and using Python's introspection
+features it will extract all function, method and class signatures. It will
+also extract the accompanying docstrings, and compile it all into well
+structured and easily readable documentation for your project.
+
.. note::
Sphinx is famous for its API generation, but it also works well
@@ -127,6 +132,30 @@ Some tools use docstrings to embed more-than-documentation behavior,
such as unit test logic. Those can be nice, but you won't ever go
wrong with vanilla "here's what this does."
+Tools like Sphinx_ will parse your docstrings as reStructuredText and render it
+correctly as HTML. This makes it very easy to embed snippets of example code in
+a project's documentation.
+
+Additionally, Doctest_ will read all embedded docstrings that look like input
+from the Python commandline (prefixed with ">>>") and run them, checking to see
+if the output of the command matches the text on the following line. This
+allows developers to embed real examples and usage of functions alongside
+their source code, and as a side effect, it also ensures that their code is
+tested and works.
+
+::
+
+ def my_function(a, b):
+ """
+ >>> my_function(2, 3)
+ 6
+ >>> my_function('a', 3)
+ 'aaa'
+ """
+ return a * b
+
+.. _Doctest: https://docs.python.org/3/library/doctest.html
+
Docstrings versus Block comments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -141,8 +170,99 @@ comment block is a programmer's note. The docstring describes the
"""Returns the square root of self times self."""
...
+Unlike block comments, docstrings are built into the Python language itself.
+This means you can use all of Python's powerful introspection capabilities to
+access docstrings at runtime, compared with comments which are optimised out.
+Docstrings are accessible from both the `__doc__` dunder attribute for almost
+every Python object, as well as with the built in `help()` function.
+
+While block comments are usually used to explain *what* a section of code is
+doing, or the specifics of an algorithm, docstrings are more intended for
+explaining to other users of your code (or you in 6 months time) *how* a
+particular function can be used and the general purpose of a function, class,
+or module.
+
+Writing Docstrings
+~~~~~~~~~~~~~~~~~~
+
+Depending on the complexity of the function, method, or class being written, a
+one-line docstring may be perfectly appropriate. These are generally used for
+really obvious cases, such as::
+
+ def add(a, b):
+ """Add two numbers and return the result."""
+ return a + b
+
+The docstring should describe the function in a way that is easy to understand.
+Embedding the function's signature in the docstring is unnecessary because it
+can easily be obtained using the `inspect` module, and doesn't provide much
+additional information.
+
+For more complex cases, there are a couple generally accepted styles used
+when writing documentation. The first of these uses reStructuredText syntax
+to format arguments and other elements of the docstring appropriately::
+
+ def function1(self, arg1, arg2, arg3):
+ """A short, one line summary of the function.
+
+ This is a longer explanation, which may include math with
+ latex syntax :math:`\\alpha`.
+
+ :param arg1: the first value
+ :param arg2: the first value
+ :param arg3: the first value
+ :type arg1: int, float,...
+ :type arg2: int, float,...
+ :type arg3: int, float,...
+ :returns: arg1/arg2 +arg3
+ :rtype: int, float
+ """
+ return arg1/arg2 + arg3
+
+`thomas-cokelaer.info`_ has a fairly complete article showing more examples for
+this style.
+
+While the end result is parsed by Sphinx and renders correctly in a browser, it
+isn't the easiest of formats to read. The `NumPy style`_ is a lot nicer to read,
+however it consumes a lot more real estate than the previous style::
+
+ def random_number_generator(arg1, arg2):
+ """
+ Summary line.
+
+ Extended description of function.
+
+ Parameters
+ ----------
+ arg1 : int
+ Description of arg1
+ arg2 : str
+ Description of arg2
+
+ Returns
+ -------
+ int
+ Description of return value
+
+ """
+ return 42
+
+The `sphinx.ext.napoleon`_ plugin allows Sphinx to parse this style of
+docstrings, making it easy to incorporate NumPy style docstrings into your
+project.
+
+At the end of the day, it doesn't really matter what style is used for writing
+docstrings, their purpose is to serve as documentation for anyone who may need
+to read or make changes to your code. As long as it is correct, understandable
+and gets the relevant points across then it has done the job it was designed to
+do.
+
+
.. see also:: Further reading on docstrings: :pep:`257`
+.. _thomas-cokelaer.info: http://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html
+.. _sphinx.ext.napoleon: https://sphinxcontrib-napoleon.readthedocs.io/
+.. _`NumPy style`: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html
Other Tools
-----------
From fb388b8f7bffabc728b1a90178eed16515f61585 Mon Sep 17 00:00:00 2001
From: Michael Bryan
Date: Sun, 12 Jun 2016 19:53:40 +0800
Subject: [PATCH 008/471] changed the pep 257 line from a see also to a normal
line
---
docs/writing/documentation.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst
index cb541e13c..036868167 100644
--- a/docs/writing/documentation.rst
+++ b/docs/writing/documentation.rst
@@ -258,7 +258,7 @@ and gets the relevant points across then it has done the job it was designed to
do.
-.. see also:: Further reading on docstrings: :pep:`257`
+For further reading on docstrings, feel free to consult :pep:`257`
.. _thomas-cokelaer.info: http://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html
.. _sphinx.ext.napoleon: https://sphinxcontrib-napoleon.readthedocs.io/
From 3c0b0270baad77a813bf1dedb5674ba159f966d1 Mon Sep 17 00:00:00 2001
From: Michael Bryan
Date: Mon, 13 Jun 2016 09:49:18 +0800
Subject: [PATCH 009/471] Removed the rst/sphinx-style docstring example
---
docs/writing/documentation.rst | 31 ++++---------------------------
1 file changed, 4 insertions(+), 27 deletions(-)
diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst
index 036868167..c5f822197 100644
--- a/docs/writing/documentation.rst
+++ b/docs/writing/documentation.rst
@@ -198,33 +198,10 @@ Embedding the function's signature in the docstring is unnecessary because it
can easily be obtained using the `inspect` module, and doesn't provide much
additional information.
-For more complex cases, there are a couple generally accepted styles used
-when writing documentation. The first of these uses reStructuredText syntax
-to format arguments and other elements of the docstring appropriately::
-
- def function1(self, arg1, arg2, arg3):
- """A short, one line summary of the function.
-
- This is a longer explanation, which may include math with
- latex syntax :math:`\\alpha`.
-
- :param arg1: the first value
- :param arg2: the first value
- :param arg3: the first value
- :type arg1: int, float,...
- :type arg2: int, float,...
- :type arg3: int, float,...
- :returns: arg1/arg2 +arg3
- :rtype: int, float
- """
- return arg1/arg2 + arg3
-
-`thomas-cokelaer.info`_ has a fairly complete article showing more examples for
-this style.
-
-While the end result is parsed by Sphinx and renders correctly in a browser, it
-isn't the easiest of formats to read. The `NumPy style`_ is a lot nicer to read,
-however it consumes a lot more real estate than the previous style::
+For more detailed documentation of code a popular style is the one used for the
+Numpy project, often called `Numpy style`_ docstrings. While it can take up a
+few more lines than usual, it allows the developer to include a lot more
+information about a method, function, or class. ::
def random_number_generator(arg1, arg2):
"""
From 10defd73a2f1cb34887f178dc119c32c2dbbba8d Mon Sep 17 00:00:00 2001
From: Michael Bryan
Date: Mon, 13 Jun 2016 10:07:29 +0800
Subject: [PATCH 010/471] Added a bit so the transition from short to long
docstrings flows better
---
docs/writing/documentation.rst | 16 +++++++++++-----
1 file changed, 11 insertions(+), 5 deletions(-)
diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst
index c5f822197..b15935179 100644
--- a/docs/writing/documentation.rst
+++ b/docs/writing/documentation.rst
@@ -194,14 +194,20 @@ really obvious cases, such as::
return a + b
The docstring should describe the function in a way that is easy to understand.
-Embedding the function's signature in the docstring is unnecessary because it
-can easily be obtained using the `inspect` module, and doesn't provide much
-additional information.
+For simple cases like trivial functions and classes, simply embedding the
+function's signature (i.e. `add(a, b) -> result`) in the docstring is
+unnecessary. This is because with Python's `inspect` module, it is already
+quite easy to find this information if needed, and it is also readily available
+by reading the source code.
+
+In larger or more complex projects however, it is often a good idea to give
+more information about a function, what it does, any exceptions it may raise,
+what it returns, or relevant details about the parameters.
For more detailed documentation of code a popular style is the one used for the
Numpy project, often called `Numpy style`_ docstrings. While it can take up a
-few more lines than usual, it allows the developer to include a lot more
-information about a method, function, or class. ::
+few more lines the previous example, it allows the developer to include a lot
+more information about a method, function, or class. ::
def random_number_generator(arg1, arg2):
"""
From 081c47511f6f7357154b9738ac5c3df6ffac0b6b Mon Sep 17 00:00:00 2001
From: nhumrich
Date: Tue, 21 Jun 2016 12:28:06 -0600
Subject: [PATCH 011/471] Update cli.rst
Add cement to cli frameworks
---
docs/scenarios/cli.rst | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst
index c8cdcec73..ccd968146 100644
--- a/docs/scenarios/cli.rst
+++ b/docs/scenarios/cli.rst
@@ -62,3 +62,13 @@ subcommands, output formatters, and other extensions. The framework is meant
to be used to create multi-level commands such as subversion and git, where
the main program handles some basic argument parsing and then invokes a
sub-command to do the work.
+
+Cement
+------
+
+`Cement `_ is an advanced CLI Application Framework.
+Its goal is to introduce a standard, and feature-full platform
+for both simple and complex command line applications as well
+as support rapid development needs without sacrificing quality.
+Cement is flexible, and it's use cases span from the simplicity of a micro-framework
+to the complexity of a meg-framework.
From 122f67bf050d35530aee4fc6d8886b4ba73f6cdd Mon Sep 17 00:00:00 2001
From: kikisdeliveryservice
Date: Tue, 21 Jun 2016 13:06:58 -0700
Subject: [PATCH 012/471] Clean up of tests.rst
---
docs/writing/tests.rst | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/docs/writing/tests.rst b/docs/writing/tests.rst
index 84e5d27db..08495300d 100644
--- a/docs/writing/tests.rst
+++ b/docs/writing/tests.rst
@@ -3,8 +3,8 @@ Testing Your Code
Testing your code is very important.
-Getting used to writing the testing code and the running code in parallel is
-now considered a good habit. Used wisely, this method helps you define more
+Getting used to writing testing code and running this code in parallel is now
+considered a good habit. Used wisely, this method helps you define more
precisely your code's intent and have a more decoupled architecture.
Some general rules of testing:
@@ -12,8 +12,8 @@ Some general rules of testing:
- A testing unit should focus on one tiny bit of functionality and prove it
correct.
-- Each test unit must be fully independent. Each of them must be able to run
- alone, and also within the test suite, regardless of the order they are
+- Each test unit must be fully independent. Each test must be able to run
+ alone, and also within the test suite, regardless of the order that they are
called. The implication of this rule is that each test must be loaded with
a fresh dataset and may have to do some cleanup afterwards. This is
usually handled by :meth:`setUp()` and :meth:`tearDown()` methods.
@@ -27,8 +27,8 @@ Some general rules of testing:
tests as often as needed.
- Learn your tools and learn how to run a single test or a test case. Then,
- when developing a function inside a module, run this function's tests very
- often, ideally automatically when you save the code.
+ when developing a function inside a module, run this function's tests
+ frequently, ideally automatically when you save the code.
- Always run the full test suite before a coding session, and run it again
after. This will give you more confidence that you did not break anything
@@ -63,11 +63,11 @@ Some general rules of testing:
- Another use of the testing code is as an introduction to new developers. When
someone will have to work on the code base, running and reading the related
- testing code is often the best they can do. They will or should discover the
- hot spots, where most difficulties arise, and the corner cases. If they have
- to add some functionality, the first step should be to add a test and, by this
- means, ensure the new functionality is not already a working path that has not
- been plugged into the interface.
+ testing code is often the best thing that they can do to start. They will
+ or should discover the hot spots, where most difficulties arise, and the
+ corner cases. If they have to add some functionality, the first step should
+ be to add a test to ensure that the new functionality is not already a
+ working path that has not been plugged into the interface.
The Basics
::::::::::
From 82a89026b9300322443a135e962b7784fdd00d1a Mon Sep 17 00:00:00 2001
From: Aaron Peschel
Date: Tue, 28 Jun 2016 15:53:53 -0700
Subject: [PATCH 013/471] Don't treat targets as files
Currently, this sample Makefile has problems if there are any
files/directories named init or test in the same directory as the
makefile. This commit adds a phony to the sample Makefile so that these
targets are not treated as files.
---
docs/writing/structure.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/docs/writing/structure.rst b/docs/writing/structure.rst
index 4f8bb3713..31f387ec9 100644
--- a/docs/writing/structure.rst
+++ b/docs/writing/structure.rst
@@ -254,6 +254,8 @@ your project.
test:
py.test tests
+ .PHONY init test
+
Other generic management scripts (e.g. ``manage.py``
or ``fabfile.py``) belong at the root of the repository as well.
From a603b95c8746f0a6333ec7fa31e4536a47a0868c Mon Sep 17 00:00:00 2001
From: Don Jayamanne
Date: Wed, 6 Jul 2016 17:17:28 +1000
Subject: [PATCH 014/471] updated to include a reference to VS Code
---
docs/dev/env.rst | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/docs/dev/env.rst b/docs/dev/env.rst
index 41ec2d70e..3e0325336 100644
--- a/docs/dev/env.rst
+++ b/docs/dev/env.rst
@@ -150,6 +150,14 @@ features can be brought to IntelliJ with the free
versions of PyCharm: Professional Edition (Free 30-day trial) and Community
Edition(Apache 2.0 License) with fewer features.
+Python (on Visual Studio Code)
+-----------------------------
+
+`Python for Visual Studio `_ is an extension for the `Visual Studio Code IDE `_.
+This is a free, light weight and open source IDE, with support for Mac, Windows and Linux.
+Built using open source technologies such as NodeJs and Python, with compelling features such as Intellisense (autocompletion), local and remote debugging, linting, and the like.
+MIT licensed.
+
Enthought Canopy
----------------
`Enthought Canopy `_ is a Python
From 46ca5e9323b250d9d3addff93b066c49bc1edbe5 Mon Sep 17 00:00:00 2001
From: Don Jayamanne
Date: Thu, 7 Jul 2016 00:23:31 +1000
Subject: [PATCH 015/471] fixed review issues
---
docs/dev/env.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/docs/dev/env.rst b/docs/dev/env.rst
index 3e0325336..d5870274a 100644
--- a/docs/dev/env.rst
+++ b/docs/dev/env.rst
@@ -154,8 +154,9 @@ Python (on Visual Studio Code)
-----------------------------
`Python for Visual Studio `_ is an extension for the `Visual Studio Code IDE `_.
-This is a free, light weight and open source IDE, with support for Mac, Windows and Linux.
-Built using open source technologies such as NodeJs and Python, with compelling features such as Intellisense (autocompletion), local and remote debugging, linting, and the like.
+This is a free, light weight, open source IDE, with support for Mac, Windows, and Linux.
+Built using open source technologies such as Node.js and Python, with compelling features such as Intellisense (autocompletion), local and remote debugging, linting, and the like.
+
MIT licensed.
Enthought Canopy
From d0d6f664edbf2ea2b3d34aaaebbaf6959b74fe24 Mon Sep 17 00:00:00 2001
From: Thomas Gratier
Date: Sat, 9 Jul 2016 10:33:07 +0200
Subject: [PATCH 016/471] Duplicated word
---
docs/scenarios/clibs.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/clibs.rst b/docs/scenarios/clibs.rst
index 290638e73..bae907b6b 100644
--- a/docs/scenarios/clibs.rst
+++ b/docs/scenarios/clibs.rst
@@ -39,7 +39,7 @@ types, such as structs and unions, and allows you to modify things such as
padding and alignment, if needed. It can be a bit crufty to use, but in
conjunction with the `struct `_
module, you are essentially provided full control over how your data types get
-translated into something something usable by a pure C(++) method.
+translated into something usable by a pure C(++) method.
Struct Equivalents
~~~~~~~~~~~~~~~~~~
From 82ef7f39ba6fc1570e29707eb0a332bca9e82232 Mon Sep 17 00:00:00 2001
From: Thomas Gratier
Date: Sat, 9 Jul 2016 22:46:17 +0200
Subject: [PATCH 017/471] Remove duplicated "in" word
---
docs/scenarios/admin.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst
index 7fbc9b51b..835622395 100644
--- a/docs/scenarios/admin.rst
+++ b/docs/scenarios/admin.rst
@@ -190,7 +190,7 @@ Ansible
`Ansible `_ is an open source system automation tool.
The biggest advantage over Puppet or Chef is it does not require an agent on
the client machine. Playbooks are Ansible’s configuration, deployment, and
-orchestration language and are written in in YAML with Jinja2 for templating.
+orchestration language and are written in YAML with Jinja2 for templating.
Ansible supports Python versions 2.6 and 2.7 and can be installed via pip:
From 730c97f4afcaf9c5348e23c8358e48fc2a37c32b Mon Sep 17 00:00:00 2001
From: Thomas Gratier
Date: Sun, 10 Jul 2016 00:12:12 +0200
Subject: [PATCH 018/471] Fix typo: infrustructure to infrastructure
---
docs/scenarios/admin.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst
index 835622395..0bd928dd5 100644
--- a/docs/scenarios/admin.rst
+++ b/docs/scenarios/admin.rst
@@ -262,7 +262,7 @@ To create a simple cookbook the `knife `_ comma
`Getting started with Chef `_
is a good starting point for Chef Beginners and many community maintained cookbooks that can
-serve as a good reference or tweaked to serve your infrustructure configuration needs can be
+serve as a good reference or tweaked to serve your infrastructure configuration needs can be
found on the `Chef Supermarket `_.
- `Chef Documentation `_
From ecb39fcf6a8f3b80abfab3aeef7af5c977c2a5be Mon Sep 17 00:00:00 2001
From: Thomas Gratier
Date: Sat, 16 Jul 2016 21:48:36 +0200
Subject: [PATCH 019/471] Indent unindented content in numbered list
---
docs/writing/style.rst | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/docs/writing/style.rst b/docs/writing/style.rst
index 0c6037223..7454e9465 100644
--- a/docs/writing/style.rst
+++ b/docs/writing/style.rst
@@ -124,13 +124,13 @@ inside the function) that was added "just in case" and is seemingly never used,
than to add a new optional argument and its logic when needed.
3. The **arbitrary argument list** is the third way to pass arguments to a
-function. If the function intention is better expressed by a signature with an
-extensible number of positional arguments, it can be defined with the ``*args``
-constructs. In the function body, ``args`` will be a tuple of all the
-remaining positional arguments. For example, ``send(message, *args)`` can be
-called with each recipient as an argument: ``send('Hello', 'God', 'Mom',
-'Cthulhu')``, and in the function body ``args`` will be equal to ``('God',
-'Mom', 'Cthulhu')``.
+ function. If the function intention is better expressed by a signature with
+ an extensible number of positional arguments, it can be defined with the
+ ``*args`` constructs. In the function body, ``args`` will be a tuple of all
+ the remaining positional arguments. For example, ``send(message, *args)``
+ can be called with each recipient as an argument:``send('Hello', 'God',
+ 'Mom', 'Cthulhu')``, and in the function body ``args`` will be equal to
+ ``('God', 'Mom', 'Cthulhu')``.
However, this construct has some drawbacks and should be used with caution. If a
function receives a list of arguments of the same nature, it is often more
From f31ca0a5fbdb7531d752f668816b7aa8108dcac4 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Mon, 18 Jul 2016 14:07:09 -0400
Subject: [PATCH 020/471] french!
---
docs/_templates/sidebarintro.html | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index 400b66ac2..e9162697b 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -60,7 +60,8 @@ Useful Links
Translations
\ No newline at end of file
+
From 5d4b76ca37ce0758380d939b306a78d6f9adaf8c Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Mon, 18 Jul 2016 14:07:22 -0400
Subject: [PATCH 021/471] Update sidebarlogo.html
---
docs/_templates/sidebarlogo.html | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
index b11b55183..f5e634c71 100644
--- a/docs/_templates/sidebarlogo.html
+++ b/docs/_templates/sidebarlogo.html
@@ -42,7 +42,8 @@ Other Projects
Translations
\ No newline at end of file
+
From c31000c6b8c1c520086af755645a21876bb6bacc Mon Sep 17 00:00:00 2001
From: Manas
Date: Wed, 27 Jul 2016 12:28:41 +0530
Subject: [PATCH 022/471] Update startproject in example
start-project should be startproject
https://docs.djangoproject.com/en/1.9/ref/django-admin/#django-admin-startproject
---
docs/writing/structure.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/writing/structure.rst b/docs/writing/structure.rst
index 31f387ec9..7879d1707 100644
--- a/docs/writing/structure.rst
+++ b/docs/writing/structure.rst
@@ -271,7 +271,7 @@ following, as they always have:
::
- $ django-admin.py start-project samplesite
+ $ django-admin.py startproject samplesite
The resulting repository structure looks like this:
@@ -293,7 +293,7 @@ Let's do it properly:
::
- $ django-admin.py start-project samplesite .
+ $ django-admin.py startproject samplesite .
Note the "``.``".
From ca64c6f722c00226bdfd30a58a6efc9f0bd45c3b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=BCrgen=20Hermann?=
Date: Wed, 27 Jul 2016 23:05:53 +0200
Subject: [PATCH 023/471] Mention dh-virtualenv in the Tools list
---
docs/shipping/packaging.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst
index 1c659610f..596ebafc1 100644
--- a/docs/shipping/packaging.rst
+++ b/docs/shipping/packaging.rst
@@ -184,3 +184,4 @@ Useful Tools
- `fpm `_
- `alien `_
+- `dh-virtualenv `_ (for APT/DEB omnibus packaging)
From f86e9cc096174967105c76954055e27dd92e25cb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Konrad=20F=C3=B6rstner?=
Date: Fri, 29 Jul 2016 08:29:18 +0200
Subject: [PATCH 024/471] Update link for rpy2
---
docs/scenarios/scientific.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/scientific.rst b/docs/scenarios/scientific.rst
index 8600bc9b2..92c8c801b 100644
--- a/docs/scenarios/scientific.rst
+++ b/docs/scenarios/scientific.rst
@@ -94,7 +94,7 @@ auto-alignment of data.
Rpy2
----
-`Rpy2 `_ is a Python binding for the R
+`Rpy2 `_ is a Python binding for the R
statistical package allowing the execution of R functions from Python and
passing data back and forth between the two environments. Rpy2 is the object
oriented implementation of the `Rpy `_
From 1bcc6d5cc84b5de6c2c5fccda45b0529556a7924 Mon Sep 17 00:00:00 2001
From: Robson Roberto Souza Peixoto
Date: Mon, 1 Aug 2016 00:43:48 -0300
Subject: [PATCH 025/471] Cleaning up *.py[co] and __pycache__ tip
---
docs/writing/gotchas.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/writing/gotchas.rst b/docs/writing/gotchas.rst
index 3a4c3350a..f8e2e2377 100644
--- a/docs/writing/gotchas.rst
+++ b/docs/writing/gotchas.rst
@@ -224,7 +224,7 @@ Removing Bytecode (.pyc) Files
Here's nice trick for removing all of these files, if they already exist::
- $ find . -name "*.pyc" -delete
+ $ find . -type f -name "*.py[co]" -delete -or -type d -name "__pycache__" -delete
Run that from the root directory of your project, and all ``.pyc`` files
will suddenly vanish. Much better.
From 91df42f1708875a095561965a2816774ea41fbb2 Mon Sep 17 00:00:00 2001
From: Kevin Ndung'u
Date: Wed, 10 Aug 2016 16:58:21 +0300
Subject: [PATCH 026/471] Fix .PHONY target rule
.PHONY should be followed by a colon
---
docs/writing/structure.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/writing/structure.rst b/docs/writing/structure.rst
index 7879d1707..ef0184e7e 100644
--- a/docs/writing/structure.rst
+++ b/docs/writing/structure.rst
@@ -254,7 +254,7 @@ your project.
test:
py.test tests
- .PHONY init test
+ .PHONY: init test
Other generic management scripts (e.g. ``manage.py``
or ``fabfile.py``) belong at the root of the repository as well.
From 7adc9c0d030622b6896c5aa82ef4cb48828851a0 Mon Sep 17 00:00:00 2001
From: Ahmad Jarara
Date: Sun, 28 Aug 2016 17:35:52 -0400
Subject: [PATCH 027/471] fix memoization typo, link to wikipedia's overview
---
docs/writing/structure.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/writing/structure.rst b/docs/writing/structure.rst
index ef0184e7e..87395c473 100644
--- a/docs/writing/structure.rst
+++ b/docs/writing/structure.rst
@@ -602,7 +602,7 @@ clearer and thus preferred.
This mechanism is useful for separating concerns and avoiding
external un-related logic 'polluting' the core logic of the function
or method. A good example of a piece of functionality that is better handled
-with decoration is memorization or caching: you want to store the results of an
+with decoration is `memoization ` or caching: you want to store the results of an
expensive function in a table and use them directly instead of recomputing
them when they have already been computed. This is clearly not part
of the function logic.
From 71257bed9e3c06c0e962712026791d855c7c14f8 Mon Sep 17 00:00:00 2001
From: Ahmad Jarara
Date: Mon, 29 Aug 2016 20:49:31 -0400
Subject: [PATCH 028/471] fixing markup on memoization link hint
---
docs/writing/structure.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/writing/structure.rst b/docs/writing/structure.rst
index 87395c473..a156fba7f 100644
--- a/docs/writing/structure.rst
+++ b/docs/writing/structure.rst
@@ -602,7 +602,7 @@ clearer and thus preferred.
This mechanism is useful for separating concerns and avoiding
external un-related logic 'polluting' the core logic of the function
or method. A good example of a piece of functionality that is better handled
-with decoration is `memoization ` or caching: you want to store the results of an
+with decoration is `memoization `__ or caching: you want to store the results of an
expensive function in a table and use them directly instead of recomputing
them when they have already been computed. This is clearly not part
of the function logic.
From f0867fe4d68b681de130973c692801858f1dcc2d Mon Sep 17 00:00:00 2001
From: Ahmad Jarara
Date: Wed, 31 Aug 2016 14:45:35 -0400
Subject: [PATCH 029/471] include instructions to preview changes in CONTRIB
---
CONTRIBUTING.md | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 481f3f63c..83a9cd76f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -6,6 +6,28 @@ see:
http://docs.python-guide.org/en/latest/notes/contribute/
+How to test your changes
+------------------------
+
+The html version of this guide is built with [sphinx](http://www.sphinx-doc.org/en/stable/). You may test your revisions locally by having sphinx installed. You can do this easily with pip (as described in the link).
+
+``` bash
+pip install --user sphinx
+```
+
+Then navigate to the directory of the makefile and ```make build``` or ```make html```. Sphinx will then generate the html in a folder called _build/html
+
+After navigating to this folder, you can then use python's built in webserver to view your changes locally:
+
+``` bash
+python3 -m http.server
+```
+
+By default, http.server listens on every ip address bound on your host on port 8000. To bind to a specific one, say, localhost on port 8005:
+
+``` bash
+python3 -m http.server 8005 --bind 127.0.0.1
+```
Style Guide
-----------
From 15396a5403a1563ecab439415ed7631fd6ea6cee Mon Sep 17 00:00:00 2001
From: denfromufa
Date: Thu, 1 Sep 2016 15:31:20 -0500
Subject: [PATCH 030/471] Update which-python.rst
Pythonnet supports from Python 2.6 up to Python 3.5
---
docs/starting/which-python.rst | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index b07b634f0..26732e34e 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -137,12 +137,12 @@ installation with the .NET Common Language Runtime (CLR). This is the
inverse approach to that taken by IronPython (see above), to which it
is more complementary than competing with.
-In conjunction with Mono, PythonNet enables native Python
+In conjunction with Mono, pythonnet enables native Python
installations on non-Windows operating systems, such as OS X and
Linux, to operate within the .NET framework. It can be run in
addition to IronPython without conflict.
-PythonNet supports from Python 2.3 up to Python 2.7. [#pythonnet_ver]_
+Pythonnet supports from Python 2.6 up to Python 3.5. [#pythonnet_ver1]_ [#pythonnet_ver2]_
.. [#pypy_ver] http://pypy.org/compat.html
@@ -150,6 +150,8 @@ PythonNet supports from Python 2.3 up to Python 2.7. [#pythonnet_ver]_
.. [#iron_ver] http://ironpython.codeplex.com/releases/view/81726
-.. [#pythonnet_ver] http://pythonnet.github.io/readme.html
+.. [#pythonnet_ver1] https://travis-ci.org/pythonnet/pythonnet
+
+.. [#pythonnet_ver2] https://ci.appveyor.com/project/TonyRoberts/pythonnet-480xs
.. [#pep373_eol] https://www.python.org/dev/peps/pep-0373/#id2
From cfb46b56ae8735fbd5d269e9df57b1349cc3472c Mon Sep 17 00:00:00 2001
From: Ruben Roy
Date: Wed, 14 Sep 2016 04:49:03 +0530
Subject: [PATCH 031/471] Update contents.rst.inc
Fixes layout issue in subsection 1.2.1 with latex
---
docs/contents.rst.inc | 14 ++++----------
1 file changed, 4 insertions(+), 10 deletions(-)
diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc
index c2c603dec..f84b3f06e 100644
--- a/docs/contents.rst.inc
+++ b/docs/contents.rst.inc
@@ -7,16 +7,10 @@ New to Python? Let's properly setup up your Python environment.
:maxdepth: 2
starting/which-python
-
-- Properly Install Python
-
- .. toctree::
- :maxdepth: 1
-
- starting/installation
- starting/install/osx
- starting/install/win
- starting/install/linux
+ starting/installation
+ starting/install/osx
+ starting/install/win
+ starting/install/linux
From af7d603e977efc2156d8c9e3c51b5ccb0ce4f91c Mon Sep 17 00:00:00 2001
From: Adam Chainz
Date: Wed, 21 Sep 2016 08:31:09 +0100
Subject: [PATCH 032/471] Convert readthedocs links for their .org -> .io
migration for hosted projects
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’:
> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.
Test Plan: Manually visited all the links I’ve modified.
---
docs/_templates/sidebarintro.html | 8 ++++----
docs/_templates/sidebarlogo.html | 8 ++++----
docs/dev/virtualenvs.rst | 6 +++---
docs/intro/learning.rst | 2 +-
docs/scenarios/ci.rst | 2 +-
docs/scenarios/clibs.rst | 2 +-
docs/scenarios/db.rst | 6 +++---
docs/scenarios/gui.rst | 2 +-
docs/scenarios/imaging.rst | 6 +++---
docs/scenarios/json.rst | 2 +-
docs/scenarios/web.rst | 14 +++++++-------
docs/shipping/packaging.rst | 4 ++--
docs/starting/install/osx.rst | 2 +-
docs/writing/tests.rst | 2 +-
14 files changed, 33 insertions(+), 33 deletions(-)
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index e9162697b..2c085fc5d 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -60,8 +60,8 @@ Useful Links
Translations
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
index f5e634c71..605909bc3 100644
--- a/docs/_templates/sidebarlogo.html
+++ b/docs/_templates/sidebarlogo.html
@@ -42,8 +42,8 @@ Other Projects
Translations
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index bb3f9487c..848d7ae34 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -122,7 +122,7 @@ control by adding it to the ignore list.
virtualenvwrapper
-----------------
-`virtualenvwrapper `_
+`virtualenvwrapper `_
provides a set of commands which makes working with virtual environments much
more pleasant. It also places all your virtual environments in one place.
@@ -134,7 +134,7 @@ To install (make sure **virtualenv** is already installed):
$ export WORKON_HOME=~/Envs
$ source /usr/local/bin/virtualenvwrapper.sh
-(`Full virtualenvwrapper install instructions `_.)
+(`Full virtualenvwrapper install instructions `_.)
For Windows, you can use the `virtualenvwrapper-win `_.
@@ -206,7 +206,7 @@ Other useful commands
``lssitepackages``
Shows contents of :file:`site-packages` directory.
-`Full list of virtualenvwrapper commands `_.
+`Full list of virtualenvwrapper commands `_.
virtualenv-burrito
------------------
diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst
index 8ab660867..823da5bab 100644
--- a/docs/intro/learning.rst
+++ b/docs/intro/learning.rst
@@ -38,7 +38,7 @@ without having to install Python locally.
If you want a more traditional book, *Python For You and Me* is an excellent
resource for learning all aspects of the language.
- `Python for You and Me `_
+ `Python for You and Me `_
Online Python Tutor
~~~~~~~~~~~~~~~~~~~
diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index aa8d1968f..16e0ea0df 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -35,7 +35,7 @@ automate the compile/test cycle to validate code changes.
Tox
---
-`tox `_ is an automation tool providing
+`tox `_ is an automation tool providing
packaging, testing and deployment of Python software right from the console or
CI server. It is a generic virtualenv management and test command line tool
which provides the following features:
diff --git a/docs/scenarios/clibs.rst b/docs/scenarios/clibs.rst
index bae907b6b..82e041fe3 100644
--- a/docs/scenarios/clibs.rst
+++ b/docs/scenarios/clibs.rst
@@ -4,7 +4,7 @@ Interfacing with C/C++ Libraries
C Foreign Function Interface
----------------------------
-`CFFI `_ provides a simple to use
+`CFFI `_ provides a simple to use
mechanism for interfacing with C from both CPython and PyPy. It supports two
modes: an inline ABI compatibility mode (example provided below), which allows
you to dynamically load and run functions from executable modules (essentially
diff --git a/docs/scenarios/db.rst b/docs/scenarios/db.rst
index 3ed11914f..58d9cd20b 100644
--- a/docs/scenarios/db.rst
+++ b/docs/scenarios/db.rst
@@ -60,11 +60,11 @@ peewee
`peewee `_ is another ORM with a focus
on being lightweight with support for Python 2.6+ and 3.2+ which supports
SQLite, MySQL and Postgres by default. The
-`model layer `_
+`model layer `_
is similar to that of the Django ORM and it has
-`SQL-like methods `_
+`SQL-like methods `_
to query data. While SQLite, MySQL and Postgres are supported out-of-the-box,
-there is a `collection of add-ons `_
+there is a `collection of add-ons `_
available.
PonyORM
diff --git a/docs/scenarios/gui.rst b/docs/scenarios/gui.rst
index 854fb826c..f56b212b7 100644
--- a/docs/scenarios/gui.rst
+++ b/docs/scenarios/gui.rst
@@ -28,7 +28,7 @@ applications be ported from PyGTK to PyGObject.
PyGObject aka (PyGi)
--------------------
`PyGObject `_ provides Python bindings, which gives access to the entire GNOME software platform.
-It is fully compatible with GTK+ 3. Here is a tutorial to get started with `Python GTK+ 3 Tutorial `_.
+It is fully compatible with GTK+ 3. Here is a tutorial to get started with `Python GTK+ 3 Tutorial `_.
`API Reference `_
diff --git a/docs/scenarios/imaging.rst b/docs/scenarios/imaging.rst
index 23ecece49..49d3af1eb 100644
--- a/docs/scenarios/imaging.rst
+++ b/docs/scenarios/imaging.rst
@@ -24,7 +24,7 @@ Installation
Before installing Pillow, you'll have to install Pillow's prerequisites. Find
the instructions for your platform in the
-`Pillow installation instructions `_.
+`Pillow installation instructions `_.
After that, it's straightforward:
@@ -57,7 +57,7 @@ Example
exif_data
There are more examples of the Pillow library in the
-`Pillow tutorial `_.
+`Pillow tutorial `_.
OpenSource Computer Vision
@@ -104,4 +104,4 @@ Example
There are more Python-implemented examples of OpenCV in this `collection of
tutorials
-`_.
+`_.
diff --git a/docs/scenarios/json.rst b/docs/scenarios/json.rst
index b5145fc4c..860e79435 100644
--- a/docs/scenarios/json.rst
+++ b/docs/scenarios/json.rst
@@ -47,7 +47,7 @@ simplejson
The JSON library was added to Python in version 2.6.
If you're using an earlier version of Python, the
-`simplejson `_ library is
+`simplejson `_ library is
available via PyPI.
simplejson mimics the json standard library. It is available so that developers
diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst
index 601e880a1..9e07a59f5 100644
--- a/docs/scenarios/web.rst
+++ b/docs/scenarios/web.rst
@@ -154,7 +154,7 @@ Gunicorn is the recommended choice for new Python web applications today.
Waitress
--------
-`Waitress `_ is a pure-python WSGI server
+`Waitress `_ is a pure-python WSGI server
that claims "very acceptable performance". Its documentation is not very
detailed, but it does offer some nice functionality that Gunicorn doesn't have
(e.g. HTTP request buffering).
@@ -166,18 +166,18 @@ Waitress is gaining popularity within the Python web development community.
uWSGI
-----
-`uWSGI `_ is a full stack for building
+`uWSGI `_ is a full stack for building
hosting services. In addition to process management, process monitoring,
and other functionality, uWSGI acts as an application server for various
programming languages and protocols - including Python and WSGI. uWSGI can
either be run as a stand-alone web router, or be run behind a full web
server (such as Nginx or Apache). In the latter case, a web server can
configure uWSGI and an application's operation over the
-`uwsgi protocol `_.
+`uwsgi protocol `_.
uWSGI's web server support allows for dynamically configuring
Python, passing environment variables and further tuning. For full details,
see `uWSGI magic
-variables `_.
+variables `_.
I do not recommend using uWSGI unless you know why you need it.
@@ -393,10 +393,10 @@ Jinja2 is the recommended templating library for new Python web applications.
Chameleon
---------
-`Chameleon `_ Page Templates are an HTML/XML template
+`Chameleon `_ Page Templates are an HTML/XML template
engine implementation of the `Template Attribute Language (TAL) `_,
-`TAL Expression Syntax (TALES) `_,
-and `Macro Expansion TAL (Metal) `_ syntaxes.
+`TAL Expression Syntax (TALES) `_,
+and `Macro Expansion TAL (Metal) `_ syntaxes.
Chameleon is available for Python 2.5 and up (including 3.x and pypy), and
is commonly used by the `Pyramid Framework `_.
diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst
index 596ebafc1..c67957529 100644
--- a/docs/shipping/packaging.rst
+++ b/docs/shipping/packaging.rst
@@ -25,7 +25,7 @@ and being able and willing to use tools such as pip to install your code's
other dependencies. This is fine when distributing to other developers, but
makes this method unsuitable for distributing applications to end-users.
-The `Python Packaging Guide `_
+The `Python Packaging Guide `_
provides an extensive guide on creating and maintaining Python packages.
Alternatives to Packaging
@@ -184,4 +184,4 @@ Useful Tools
- `fpm `_
- `alien `_
-- `dh-virtualenv `_ (for APT/DEB omnibus packaging)
+- `dh-virtualenv `_ (for APT/DEB omnibus packaging)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index 03426c554..422248590 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -77,7 +77,7 @@ software over a network (usually the Internet) with a single command
capability to your own Python software with very little work.
``pip`` is a tool for easily installing and managing Python packages,
-that is recommended over ``easy_install``. It is superior to ``easy_install`` in `several ways `_,
+that is recommended over ``easy_install``. It is superior to ``easy_install`` in `several ways `_,
and is actively maintained.
diff --git a/docs/writing/tests.rst b/docs/writing/tests.rst
index 08495300d..b8b7ca022 100644
--- a/docs/writing/tests.rst
+++ b/docs/writing/tests.rst
@@ -202,7 +202,7 @@ nose provides automatic test discovery to save you the hassle of manually
creating test suites. It also provides numerous plugins for features such as
xUnit-compatible test output, coverage reporting, and test selection.
- `nose `_
+ `nose `_
tox
From 1caa6c77509c1453fb36dfa498b94358015d6b66 Mon Sep 17 00:00:00 2001
From: "Tim D. Smith"
Date: Thu, 22 Sep 2016 12:39:35 -0700
Subject: [PATCH 033/471] CLT are not needed if full Xcode is installed
---
docs/starting/install/osx.rst | 4 ----
1 file changed, 4 deletions(-)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index 422248590..b6eb13572 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -32,10 +32,6 @@ package.
In combination, the software can cause issues that are difficult to
diagnose.
-.. note::
- If you perform a fresh install of Xcode, you will also need to add the
- commandline tools by running ``xcode-select --install`` on the terminal.
-
While OS X comes with a large number of UNIX utilities, those familiar with
Linux systems will notice one key component missing: a decent package manager.
`Homebrew `_ fills this void.
From 359e4b9e3d066d3f3f9c10dbad2af5bf4e78220a Mon Sep 17 00:00:00 2001
From: "Tim D. Smith"
Date: Thu, 22 Sep 2016 12:40:43 -0700
Subject: [PATCH 034/471] Don't specifically need gcc
---
docs/starting/install/osx.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index b6eb13572..3d14254ea 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -21,10 +21,10 @@ Doing it Right
Let's install a real version of Python.
-Before installing Python, you'll need to install GCC. GCC can be obtained
-by downloading `Xcode `_, the smaller
-`Command Line Tools `_ (must have an
-Apple account) or the even smaller `OSX-GCC-Installer `_
+Before installing Python, you'll need to install a C compiler. A compiler can be
+obtained by downloading `Xcode `_, the
+smaller `Command Line Tools `_ (must
+have an Apple account) or the even smaller `OSX-GCC-Installer `_
package.
.. note::
From 1d516898b3f6872b8cda1b823797781f64cfb87d Mon Sep 17 00:00:00 2001
From: "Tim D. Smith"
Date: Thu, 22 Sep 2016 12:45:16 -0700
Subject: [PATCH 035/471] Update guidance on C toolchains
---
docs/starting/install/osx.rst | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index 3d14254ea..e8aa1dfd7 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -21,16 +21,18 @@ Doing it Right
Let's install a real version of Python.
-Before installing Python, you'll need to install a C compiler. A compiler can be
-obtained by downloading `Xcode `_, the
-smaller `Command Line Tools `_ (must
-have an Apple account) or the even smaller `OSX-GCC-Installer `_
+Before installing Python, you'll need to install a C compiler. The fastest way
+is to install the Xcode Command Line Tools by running
+``xcode-select --install``. You can also download the full version of
+`Xcode `_ from the Mac App Store, or the
+minimal but unofficial
+`OSX-GCC-Installer `_
package.
.. note::
- If you already have Xcode installed, do not install OSX-GCC-Installer.
- In combination, the software can cause issues that are difficult to
- diagnose.
+ If you already have Xcode installed or plan to use Homebrew, do not install
+ OSX-GCC-Installer. In combination, the software can cause issues that are
+ difficult to diagnose.
While OS X comes with a large number of UNIX utilities, those familiar with
Linux systems will notice one key component missing: a decent package manager.
From 2423a9da64181d8a55be72fc269e7f6ac3d011f1 Mon Sep 17 00:00:00 2001
From: "Tim D. Smith"
Date: Thu, 22 Sep 2016 12:45:24 -0700
Subject: [PATCH 036/471] Offer guidance on Python 3
---
docs/starting/install/osx.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index e8aa1dfd7..5c73d69a2 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -61,6 +61,12 @@ Now, we can install Python 2.7:
$ brew install python
+or Python 3:
+
+.. code-block:: console
+
+ $ brew install python3
+
This will take a minute or two.
From ab3332e42c0ba4694e171090d564aa5a0af5d53f Mon Sep 17 00:00:00 2001
From: Kishor Bhat
Date: Thu, 29 Sep 2016 11:36:11 +0530
Subject: [PATCH 037/471] Remove redundant statement
---
docs/scenarios/admin.rst | 2 --
1 file changed, 2 deletions(-)
diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst
index 0bd928dd5..8e738d9c0 100644
--- a/docs/scenarios/admin.rst
+++ b/docs/scenarios/admin.rst
@@ -378,8 +378,6 @@ Buildout is primarily used to download and set up dependencies in Python eggs
format of the software being developed or deployed. Recipes for build tasks in any
environment can be created, and many are already available.
-Buidout is written in Python.
-
Shinken
-------
From 5ad43199debdd2d33eab35190c8c3a9d4f60ca42 Mon Sep 17 00:00:00 2001
From: Sidney Pham
Date: Fri, 7 Oct 2016 15:53:05 +1100
Subject: [PATCH 038/471] Fixed example docstring
---
docs/writing/documentation.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst
index bd59437e8..7e10ab49f 100644
--- a/docs/writing/documentation.rst
+++ b/docs/writing/documentation.rst
@@ -104,7 +104,7 @@ In Python, *docstrings* describe modules, classes, and functions:
.. code-block:: python
def square_and_rooter(x):
- """Returns the square root of self times self."""
+ """Return the square root of self times self."""
...
In general, follow the comment section of :pep:`8#comments` (the "Python Style
From 25dc76e5365ba6a9833163dbf3450da227c71d21 Mon Sep 17 00:00:00 2001
From: Kishor Bhat
Date: Fri, 7 Oct 2016 15:36:14 +0530
Subject: [PATCH 039/471] Remove numba todo; already taken care of under
scenarios/scientific.rst
---
docs/scenarios/speed.rst | 4 ----
1 file changed, 4 deletions(-)
diff --git a/docs/scenarios/speed.rst b/docs/scenarios/speed.rst
index fc038c1c7..2c775b880 100644
--- a/docs/scenarios/speed.rst
+++ b/docs/scenarios/speed.rst
@@ -222,10 +222,6 @@ Pyrex
Shedskin?
---------
-Numba
------
-.. todo:: Write about Numba and the autojit compiler for NumPy
-
Concurrency
:::::::::::
From 473f4c77a7aee526f3658188d036e2db58b67b89 Mon Sep 17 00:00:00 2001
From: Austin
Date: Sun, 16 Oct 2016 09:00:42 -0400
Subject: [PATCH 040/471] Remove Ubuntu specification
The linked page is general to linux, and specifically mentions CentOS, Fedora, RHEL and Ubuntu. It does not contain any information that is specific to Ubuntu only.
---
docs/starting/installation.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/starting/installation.rst b/docs/starting/installation.rst
index 04aaaa0b8..5df0035f3 100644
--- a/docs/starting/installation.rst
+++ b/docs/starting/installation.rst
@@ -18,4 +18,4 @@ for development purposes, as well as setuptools, pip, and virtualenv setup.
- :ref:`Mac OS X `.
- :ref:`Microsoft Windows `.
-- :ref:`Ubuntu Linux `.
+- :ref:`Linux `.
From 111c5d67698604526de994d222665a0bab536561 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 20 Oct 2016 02:24:28 -0400
Subject: [PATCH 041/471] available now!
---
docs/_templates/sidebarintro.html | 2 +-
docs/_templates/sidebarlogo.html | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index 2c085fc5d..5a49dc072 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -22,7 +22,7 @@ Stay Informed
O'Reilly Book
-This guide is now available for pre-order in tangible book form!
+This guide is now available in tangible book form!

diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
index 605909bc3..bea79f74c 100644
--- a/docs/_templates/sidebarlogo.html
+++ b/docs/_templates/sidebarlogo.html
@@ -21,7 +21,7 @@ Get Updates
O'Reilly Book
-This guide is now available for pre-order in tangible book form!
+This guide is now available in tangible book form!

From d67923cf94d20db423cee2b841415ba4a4b36535 Mon Sep 17 00:00:00 2001
From: Aditya
Date: Wed, 26 Oct 2016 19:12:11 +0530
Subject: [PATCH 042/471] Update the link for latest available Python 2.7
release for Windows
---
docs/starting/install/win.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/starting/install/win.rst b/docs/starting/install/win.rst
index a34566ecc..674bb683f 100644
--- a/docs/starting/install/win.rst
+++ b/docs/starting/install/win.rst
@@ -3,7 +3,7 @@
Installing Python on Windows
============================
-First, download the `latest version `_
+First, download the `latest version `_
of Python 2.7 from the official Website. If you want to be sure you are installing a fully
up-to-date version, click the Downloads > Windows link from the home page of the
`Python.org web site `_ .
From be8ce2704df28a3279ee1d6f5809ee776dcf327d Mon Sep 17 00:00:00 2001
From: Aditya
Date: Wed, 26 Oct 2016 20:37:54 +0530
Subject: [PATCH 043/471] Update to recent versions of Django for virtualenv
example
---
docs/dev/virtualenvs.rst | 4 ++--
docs/starting/install/linux.rst | 4 ++--
docs/starting/install/osx.rst | 4 ++--
docs/starting/install/win.rst | 4 ++--
4 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index 848d7ae34..e6be87f89 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -8,8 +8,8 @@ projects in separate places, by creating virtual Python environments for them.
It solves the "Project X depends on version 1.x but, Project Y needs 4.x"
dilemma, and keeps your global site-packages directory clean and manageable.
-For example, you can work on a project which requires Django 1.3 while also
-maintaining a project which requires Django 1.0.
+For example, you can work on a project which requires Django 1.10 while also
+maintaining a project which requires Django 1.8.
virtualenv
----------
diff --git a/docs/starting/install/linux.rst b/docs/starting/install/linux.rst
index e68c5d0d5..aa56ec07d 100644
--- a/docs/starting/install/linux.rst
+++ b/docs/starting/install/linux.rst
@@ -55,8 +55,8 @@ in separate places, by creating virtual Python environments for them. It solves
"Project X depends on version 1.x but, Project Y needs 4.x" dilemma, and keeps
your global site-packages directory clean and manageable.
-For example, you can work on a project which requires Django 1.3 while also
-maintaining a project which requires Django 1.0.
+For example, you can work on a project which requires Django 1.10 while also
+maintaining a project which requires Django 1.8.
To start using this and see more information: :ref:`Virtual Environments ` docs.
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index 422248590..a4fa0cf04 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -89,8 +89,8 @@ in separate places, by creating virtual Python environments for them. It solves
"Project X depends on version 1.x but, Project Y needs 4.x" dilemma, and keeps
your global site-packages directory clean and manageable.
-For example, you can work on a project which requires Django 1.3 while also
-maintaining a project which requires Django 1.0.
+For example, you can work on a project which requires Django 1.10 while also
+maintaining a project which requires Django 1.8.
To start using this and see more information: :ref:`Virtual Environments ` docs.
diff --git a/docs/starting/install/win.rst b/docs/starting/install/win.rst
index 674bb683f..131ace663 100644
--- a/docs/starting/install/win.rst
+++ b/docs/starting/install/win.rst
@@ -74,8 +74,8 @@ in separate places, by creating virtual Python environments for them. It solves
"Project X depends on version 1.x but, Project Y needs 4.x" dilemma, and keeps
your global site-packages directory clean and manageable.
-For example, you can work on a project which requires Django 1.3 while also
-maintaining a project which requires Django 1.0.
+For example, you can work on a project which requires Django 1.10 while also
+maintaining a project which requires Django 1.8.
To start using this and see more information: :ref:`Virtual Environments ` docs.
From fe7467bcc426bada462c77087085ca1389341e5e Mon Sep 17 00:00:00 2001
From: Adam Zapletal
Date: Sat, 29 Oct 2016 18:24:14 -0500
Subject: [PATCH 044/471] Update link to Mercurial site
---
docs/scenarios/cli.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst
index c8cdcec73..899979215 100644
--- a/docs/scenarios/cli.rst
+++ b/docs/scenarios/cli.rst
@@ -16,7 +16,7 @@ Some popular command-line applications include:
* `httpie `_ - A command line HTTP
client, a user-friendly cURL replacement
* `git `_ - A distributed version control system
-* `mercurial `_ - A distributed version control
+* `mercurial `_ - A distributed version control
system primarily written in Python
Clint
From 27c1567df56125359f96dad9d31e2664a025ddde Mon Sep 17 00:00:00 2001
From: Shiven Mian
Date: Mon, 31 Oct 2016 14:50:30 +0530
Subject: [PATCH 045/471] added machine learning docs
---
docs/scenarios/ml.rst | 117 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 117 insertions(+)
create mode 100644 docs/scenarios/ml.rst
diff --git a/docs/scenarios/ml.rst b/docs/scenarios/ml.rst
new file mode 100644
index 000000000..25cab8045
--- /dev/null
+++ b/docs/scenarios/ml.rst
@@ -0,0 +1,117 @@
+================
+Machine Learning
+================
+
+Python has a vast number of libraries for data analysis, statistics and Machine Learning itself, making it a language of choice for many data scientists.
+
+Some widely used packages for Machine Learning and other Data Science applications are enlisted below.
+
+Scipy Stack
+-----------
+
+The Scipy stack consists of a bunch of core helper packages used in data science, for statistical analysis and visualising data. Because of its huge number of functionalities and ease of use, the Stack is considered a must-have for most data science applications.
+
+The Stack consists of the following packages (link to documentation given):
+
+1. `NumPy `_
+2. `SciPy library `_
+3. `Matplotlib `_
+4. `IPython `_
+5. `pandas `_
+6. `Sympy `_
+7. `nose `_
+
+The stack also comes with Python bundled in, but has been excluded from the above list.
+
+Installation
+~~~~~~~~~~~~
+
+For installing the full stack, or individual packages, you can refer to the instructions given `here `_.
+
+**NB:** `Anaconda `_ is highly preferred and recommended for installing and maintaining data science packages seamlessly.
+
+scikit-learn
+------------
+
+Scikit is a free and open-source machine learning library for Python. It offers off-the-shelf functions to implement many algorithms like linear regression, classifiers, SVMs, k-means, Neural Networks etc. It also has a few sample datasets which can be directly used for training and testing.
+
+Because of its speed, robustness and easiness to use, it's one of the most widely-used libraries for many Machine Learning applications.
+
+Installation
+~~~~~~~~~~~~
+
+Through PyPI:
+
+.. code-block:: python
+
+ pip install -U scikit-learn
+
+Through conda:
+
+.. code-block:: python
+
+ conda install scikit-learn
+
+scikit-learn also comes in shipped with Anaconda (mentioned above). For more installation instructions, refer to `this link `_.
+
+Example
+~~~~~~~
+
+For this example, we train a simple classifier on the `Iris dataset `_, which comes bundled in with scikit-learn.
+
+The dataset takes four features of flowers: sepal length, sepal width, petal length and petal width, and classifies them into three flower species (labels): setosa, versicolor or virginica. The labels have been represented as numbers in the dataset: 0 (setosa), 1 (versicolor) and 2 (virginica).
+
+We shuffle the Iris dataset, and divide it into separate training and testing sets: keeping the last 10 data points for testing and rest for training. We then train the classifier on the training set, and predict on the testing set.
+
+.. code-block:: python
+
+ from sklearn.datasets import load_iris
+ from sklearn import tree
+ from sklearn.metrics import accuracy_score
+ import numpy as np
+
+ #loading the iris dataset
+ iris = load_iris()
+
+ x = iris.data #array of the data
+ y = iris.target #array of labels (i.e answers) of each data entry
+
+ #getting label names i.e the three flower species
+ y_names = iris.target_names
+
+ #taking random indices to split the dataset into train and test
+ test_ids = np.random.permutation(len(x))
+
+ #splitting data and labels into train and test
+ #keeping last 10 entries for testing, rest for training
+
+ x_train = x[test_ids[:-10]]
+ x_test = x[test_ids[-10:]]
+
+ y_train = y[test_ids[:-10]]
+ y_test = y[test_ids[-10:]]
+
+ #classifying using decision tree
+ clf = tree.DecisionTreeClassifier()
+
+ #training (fitting) the classifier with the training set
+ clf.fit(x_train, y_train)
+
+ #predictions on the test dataset
+ pred = clf.predict(x_test)
+
+ print pred #predicted labels i.e flower species
+ print y_test #actual labels
+ print (accuracy_score(pred, y_test))*100 #prediction accuracy
+
+Since we're splitting randomly and the classifier trains on every iteration, the accuracy may vary. Running the above code gives:
+
+.. code-block:: python
+
+ [0 1 1 1 0 2 0 2 2 2]
+ [0 1 1 1 0 2 0 2 2 2]
+ 100.0
+
+The first line contains the labels (i.e flower species) of the testing data as predicted by our classifier, and the second line contains the actual flower species as given in the dataset. We thus get an accuracy of 100% this time.
+
+More on scikit-learn can be read in the `documentation `_.
\ No newline at end of file
From 3a353c64f41bc530c65be199eb4e8c85e9ddc9d1 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Wed, 2 Nov 2016 11:23:21 -0400
Subject: [PATCH 046/471] ml
---
docs/contents.rst.inc | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc
index f84b3f06e..f2cad22b0 100644
--- a/docs/contents.rst.inc
+++ b/docs/contents.rst.inc
@@ -58,6 +58,7 @@ different scenarios.
scenarios/xml
scenarios/json
scenarios/crypto
+ scenarios/ml
scenarios/clibs
From 4a7336f8ffbb9002adf6703609406147e7e6c266 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Wed, 2 Nov 2016 11:35:47 -0400
Subject: [PATCH 047/471] Revert "Update contents.rst.inc"
---
docs/contents.rst.inc | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc
index f2cad22b0..22cbdc940 100644
--- a/docs/contents.rst.inc
+++ b/docs/contents.rst.inc
@@ -7,10 +7,16 @@ New to Python? Let's properly setup up your Python environment.
:maxdepth: 2
starting/which-python
- starting/installation
- starting/install/osx
- starting/install/win
- starting/install/linux
+
+- Properly Install Python
+
+ .. toctree::
+ :maxdepth: 1
+
+ starting/installation
+ starting/install/osx
+ starting/install/win
+ starting/install/linux
From 7c8dfd0d3e8f4cafe874d293c2ed647cf8d91844 Mon Sep 17 00:00:00 2001
From: Chocobo1
Date: Sun, 6 Nov 2016 19:57:59 +0800
Subject: [PATCH 048/471] Correct name for the game "Civilization IV"
---
docs/shipping/freezing.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/shipping/freezing.rst b/docs/shipping/freezing.rst
index d42f2d61b..4e2de50e8 100644
--- a/docs/shipping/freezing.rst
+++ b/docs/shipping/freezing.rst
@@ -8,7 +8,7 @@ Freezing Your Code
to end-users, that contains all of your application code as well as the
Python interpreter.
-Applications such as 'Dropbox', 'Eve Online', 'Civilisation IV', and
+Applications such as 'Dropbox', 'Eve Online', 'Civilization IV', and
BitTorrent clients do this.
The advantage of distributing this way is that your application will "just work",
From b832f669e682d5b4f97e2bb4e71e62f8834871c9 Mon Sep 17 00:00:00 2001
From: Adam Nelson
Date: Mon, 14 Nov 2016 14:31:53 -0500
Subject: [PATCH 049/471] Previous merge didnt handle 2 conflicts properly
---
docs/dev/virtualenvs.rst | 4 ----
docs/starting/install/osx.rst | 24 ++----------------------
2 files changed, 2 insertions(+), 26 deletions(-)
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index d8d746c7e..927d213fa 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -8,11 +8,7 @@ projects in separate places, by creating virtual Python environments for them.
It solves the "Project X depends on version 1.x but, Project Y needs 4.x"
dilemma, and keeps your global site-packages directory clean and manageable.
-<<<<<<< HEAD
-For example, you can work on a project which requires Django 1.9 while also
-=======
For example, you can work on a project which requires Django 1.10 while also
->>>>>>> upstream/master
maintaining a project which requires Django 1.8.
virtualenv
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index bc5e53928..fe081b3d8 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -74,9 +74,6 @@ Now, we can install Python 2.7:
$ brew install python
-<<<<<<< HEAD
-This will take a minute or two.
-=======
or Python 3:
.. code-block:: console
@@ -84,7 +81,6 @@ or Python 3:
$ brew install python3
This will take a minute or two.
->>>>>>> upstream/master
Setuptools and Pip
@@ -93,23 +89,13 @@ Setuptools and Pip
Homebrew installs Setuptools and ``pip`` for you.
Setuptools enables you to download and install any compliant Python
-<<<<<<< HEAD
- -software over a network (usually the Internet) with a single command
- -(``easy_install``). It also enables you to add this network installation
- -capability to your own Python software with very little work.
-
-``pip`` is a tool for easily installing and managing Python packages, that is
-recommended over ``easy_install``. It is superior to
-``easy_install`` in `several ways
-`_,
-=======
software over a network (usually the Internet) with a single command
(``easy_install``). It also enables you to add this network installation
capability to your own Python software with very little work.
``pip`` is a tool for easily installing and managing Python packages,
-that is recommended over ``easy_install``. It is superior to ``easy_install`` in `several ways `_,
->>>>>>> upstream/master
+that is recommended over ``easy_install``. It is superior to ``easy_install``
+in `several ways `_,
and is actively maintained.
@@ -122,14 +108,8 @@ in separate places, by creating virtual Python environments for them. It solves
your global site-packages directory clean and manageable.
For example, you can work on a project which requires Django 1.10 while also
-<<<<<<< HEAD
-maintaining a project which requires Django 1.7.
-=======
maintaining a project which requires Django 1.8.
-To start using this and see more information: :ref:`Virtual Environments ` docs.
->>>>>>> upstream/master
-
To start using this and see more information: :ref:`Virtual Environments ` docs.
--------------------------------
From 0d3c9a131f566f56a6256e3e507fbef3733c93c1 Mon Sep 17 00:00:00 2001
From: Adam Nelson
Date: Mon, 14 Nov 2016 14:47:23 -0500
Subject: [PATCH 050/471] Previous merge did not handle 1 more conflict
properly :-(
---
docs/starting/install/osx.rst | 7 +------
1 file changed, 1 insertion(+), 6 deletions(-)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index fe081b3d8..97baf03d8 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -33,7 +33,6 @@ minimal but unofficial
package.
.. note::
-<<<<<<< HEAD
If you already have XCode installed, do not install OSX-GCC-Installer.
In combination, the software can cause issues that are difficult to
diagnose.
@@ -41,11 +40,7 @@ package.
.. note::
If you perform a fresh install of XCode, you will also need to add the
commandline tools by running ``xcode-select --install`` on the terminal.
-=======
- If you already have Xcode installed or plan to use Homebrew, do not install
- OSX-GCC-Installer. In combination, the software can cause issues that are
- difficult to diagnose.
->>>>>>> upstream/master
+
While OS X comes with a large number of UNIX utilities, those familiar with
Linux systems will notice one key component missing: a decent package manager.
From 35372867d9b7f2c7e0907e13697198776159d467 Mon Sep 17 00:00:00 2001
From: Gabriel Pitali
Date: Thu, 17 Nov 2016 09:05:10 -0200
Subject: [PATCH 051/471] Update link for ez_setup.py
Update link for ez_setup.py, in python-guide/docs/starting/install/win.rst file, because the old link was broken.
---
docs/starting/install/win.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/starting/install/win.rst b/docs/starting/install/win.rst
index 131ace663..6496a3a78 100644
--- a/docs/starting/install/win.rst
+++ b/docs/starting/install/win.rst
@@ -54,7 +54,7 @@ command. It also enables you to add this network installation capability to
your own Python software with very little work.
To obtain the latest version of Setuptools for Windows, run the Python script
-available here: `ez_setup.py `_
+available here: `ez_setup.py `_
You'll now have a new command available to you: **easy_install**. It is
From 1d6d88bbb9105756725e67eb42e421c3b724813f Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sun, 20 Nov 2016 22:50:12 -0500
Subject: [PATCH 052/471] Update sidebarlogo.html
---
docs/_templates/sidebarlogo.html | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
index bea79f74c..64db4c4ae 100644
--- a/docs/_templates/sidebarlogo.html
+++ b/docs/_templates/sidebarlogo.html
@@ -16,7 +16,7 @@ Get Updates
allowtransparency="true" frameborder="0" scrolling="0" width="200" height="20">
-
+Say Thanks!
Join Mailing List.
O'Reilly Book
From 521bcdaafbaa5ae19a9af339a80e1e247c157b73 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sun, 20 Nov 2016 22:50:25 -0500
Subject: [PATCH 053/471] Update sidebarintro.html
---
docs/_templates/sidebarintro.html | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index 5a49dc072..28f824998 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -19,6 +19,7 @@ Stay Informed
Join Mailing List.
+Say Thanks!
O'Reilly Book
From 1b2a943ad808bd2c6a4f495986172b1f8a682076 Mon Sep 17 00:00:00 2001
From: caimaoy
Date: Tue, 22 Nov 2016 18:36:08 +0800
Subject: [PATCH 054/471] update tox docs url
---
docs/writing/tests.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/docs/writing/tests.rst b/docs/writing/tests.rst
index b8b7ca022..a9f2bb617 100644
--- a/docs/writing/tests.rst
+++ b/docs/writing/tests.rst
@@ -218,7 +218,8 @@ multiple interpreter configurations
tox allows you to configure complicated multi-parameter test matrices via a
simple ini-style configuration file.
- `tox `_
+ `tox `_
+
Unittest2
---------
From c769b54e76ed92cbc34ba0cd5d6558e4cdb1b607 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sat, 26 Nov 2016 19:05:19 -0500
Subject: [PATCH 055/471] rewrite of 3 vs 2
---
docs/starting/which-python.rst | 29 +++++++++++------------------
1 file changed, 11 insertions(+), 18 deletions(-)
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index 26732e34e..ae7254a5b 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -13,10 +13,11 @@ one might think.
The basic gist of the state of things is as follows:
-1. Python 2.7 has been the standard for a *long* time.
-2. Python 3 introduced major changes to the language, which many developers are unhappy with.
-3. Python 2.7 will receive necessary security updates until 2020 [#pep373_eol]_.
+1. Python 2.7 has been the standard for a *long* time, and is being officially deprecated `in 2020 `_.
+2. Python 3 introduced major changes to the language, which have taken some time for the community to adjust to.
+3. As menitoned, Python 2.7 will only receive necessary security updates until 2020 [#pep373_eol]_.
4. Python 3 is continually evolving, like Python 2 did in years past.
+5. The brand name "Python" encapsulates both Python 3 and Python 2.
So, you can now see why this is not such an easy decision.
@@ -26,21 +27,13 @@ Recommendations
I'll be blunt:
-
-**Use Python 3 if...**
-
-- You don't care.
-- You love Python 3.
-- You are indifferent towards 2 vs 3.
-- You don't know which one to use.
-- You embrace change.
-
-**Use Python 2 if...**
-
-- You love Python 2 and are saddened by the future being Python 3.
-- The stability requirements of your software would be improved by a language and runtime that never changes.
-- Software that you depend on requires it.
-
+- Use Python 3 for new Python applications.
+- If you're learning Python for the first time, familiarizing yourself with Python 2.7 will be very
+ useful, but not more useful than learning Python 3. Learn both. They are both "Python".
+- Software that is already built (e.g. commercial software) often depends on Python 2.7.
+- If you are writing a new open source Python library, it's best to write it for both Python 2 and 3
+ simultaneously. Supporting 3 only is a political statment and will alienate many of your users.
+ This is not a problem — slowly, over the next three years, this will become less the case.
So.... 3?
~~~~~~~~~
From a3f777d0b4bf3683f41cc9a4679fa566b0e4903a Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sat, 26 Nov 2016 19:08:53 -0500
Subject: [PATCH 056/471] which python
---
docs/starting/which-python.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index ae7254a5b..85978f0dd 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -38,13 +38,13 @@ I'll be blunt:
So.... 3?
~~~~~~~~~
-If you're choosing a Python interpreter to use, and aren't opinionated, then I
+If you're choosing a Python interpreter to use, I
recommend you use the newest Python 3.x, since every version brings new and
-improved standard library modules, security and bug fixes. Progress is progress.
+improved standard library modules, security and bug fixes.
-Given such, only use Python 2 if you have a strong reason to, such as a Python 2
-exclusive library which has no adequate Python 3 ready alternative, or you
-(like me) absolutely love and are inspired by Python 2.
+Given such, only use Python 2 if you have a strong reason to, such as a
+pre-existing code-base, a Python 2 exclusive library, simplicity/familiarity,
+or, of course, you absolutely love and are inspired by Python 2. No harm in that.
Check out `Can I Use Python 3? `_ to see if any
software you're depending on will block your adoption of Python 3.
From f8451532834fbf18ddb8a145ba669ec231542a63 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sat, 26 Nov 2016 19:14:13 -0500
Subject: [PATCH 057/471] python 3
---
docs/starting/which-python.rst | 12 ++++--------
1 file changed, 4 insertions(+), 8 deletions(-)
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index 85978f0dd..fc8701df0 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -13,14 +13,10 @@ one might think.
The basic gist of the state of things is as follows:
-1. Python 2.7 has been the standard for a *long* time, and is being officially deprecated `in 2020 `_.
-2. Python 3 introduced major changes to the language, which have taken some time for the community to adjust to.
-3. As menitoned, Python 2.7 will only receive necessary security updates until 2020 [#pep373_eol]_.
-4. Python 3 is continually evolving, like Python 2 did in years past.
-5. The brand name "Python" encapsulates both Python 3 and Python 2.
-
-So, you can now see why this is not such an easy decision.
-
+1. Python 2.7 has been the standard for a *long* time, and most running applications today use it.
+2. The Python community is prepared and adjusted for production deployment of Python 3 applications.
+3. Python 2.7 will only receive necessary security updates until 2020 [#pep373_eol]_, then deprecate.
+4. The brand name "Python" encapsulates both Python 3 and Python 2.
Recommendations
~~~~~~~~~~~~~~~
From 0dc24a34e7d0e17ba49298b5fe0312a3834d39ec Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sat, 26 Nov 2016 19:16:50 -0500
Subject: [PATCH 058/471] less aggressive
---
docs/starting/which-python.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index fc8701df0..b8b503069 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -3,8 +3,8 @@ Picking an Interpreter
.. _which-python:
-The State of Python (2 vs 3)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The State of Python (3 & 2)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
When choosing a Python interpreter, one looming question is always present:
"Should I choose Python 2 or Python 3"? The answer is not as obvious as
From cfce3eac7a7ec91f29a3127636de7c75a7825a6e Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sat, 26 Nov 2016 19:19:14 -0500
Subject: [PATCH 059/471] further clarification
---
docs/starting/which-python.rst | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index b8b503069..b8bf97cc0 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -25,11 +25,12 @@ I'll be blunt:
- Use Python 3 for new Python applications.
- If you're learning Python for the first time, familiarizing yourself with Python 2.7 will be very
- useful, but not more useful than learning Python 3. Learn both. They are both "Python".
-- Software that is already built (e.g. commercial software) often depends on Python 2.7.
+ useful, but not more useful than learning Python 3.
+- Learn both. They are both "Python".
+- Software that is already built often depends on Python 2.7.
- If you are writing a new open source Python library, it's best to write it for both Python 2 and 3
- simultaneously. Supporting 3 only is a political statment and will alienate many of your users.
- This is not a problem — slowly, over the next three years, this will become less the case.
+ simultaneously. Only supporting Python 3 for a new library you want to be widely adopted is a
+ political statment and will alienate many of your users. This is not a problem — slowly, over the next three years, this will become less the case.
So.... 3?
~~~~~~~~~
From ed82f8d4401f510f64e80321a8b2b9a6a1671b94 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sat, 26 Nov 2016 19:24:11 -0500
Subject: [PATCH 060/471] further clarification
---
docs/starting/which-python.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index b8bf97cc0..709a55d13 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -13,9 +13,9 @@ one might think.
The basic gist of the state of things is as follows:
-1. Python 2.7 has been the standard for a *long* time, and most running applications today use it.
-2. The Python community is prepared and adjusted for production deployment of Python 3 applications.
-3. Python 2.7 will only receive necessary security updates until 2020 [#pep373_eol]_, then deprecate.
+1. Most production applications today use Python 2.7 .
+2. Python 3 is ready for the production deployment of applications today.
+3. Python 2.7 will only receive necessary security updates until 2020 [#pep373_eol]_.
4. The brand name "Python" encapsulates both Python 3 and Python 2.
Recommendations
From 3058b21a88f8f47e7abe74bda064634ab0904f40 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sat, 26 Nov 2016 19:24:58 -0500
Subject: [PATCH 061/471] subtle
---
docs/starting/which-python.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index 709a55d13..1936d0c38 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -7,7 +7,7 @@ The State of Python (3 & 2)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
When choosing a Python interpreter, one looming question is always present:
-"Should I choose Python 2 or Python 3"? The answer is not as obvious as
+"Should I choose Python 2 or Python 3"? The answer is a bit more subtle than
one might think.
From 249e7a9d2aa0eacd196f05a7902df19cc160a762 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sat, 26 Nov 2016 19:28:40 -0500
Subject: [PATCH 062/471] 2.7
---
docs/starting/which-python.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index 1936d0c38..b3befa2ed 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -13,7 +13,7 @@ one might think.
The basic gist of the state of things is as follows:
-1. Most production applications today use Python 2.7 .
+1. Most production applications today use Python 2.7.
2. Python 3 is ready for the production deployment of applications today.
3. Python 2.7 will only receive necessary security updates until 2020 [#pep373_eol]_.
4. The brand name "Python" encapsulates both Python 3 and Python 2.
From 220001839df03eb89b8f66c8b0527a5ab81d22bd Mon Sep 17 00:00:00 2001
From: Will Humphreys
Date: Tue, 29 Nov 2016 18:24:54 +0000
Subject: [PATCH 063/471] Fix missing space
---
docs/dev/env.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/dev/env.rst b/docs/dev/env.rst
index d5870274a..53d798531 100644
--- a/docs/dev/env.rst
+++ b/docs/dev/env.rst
@@ -148,7 +148,7 @@ known for IntelliJ IDEA. Both share the same code base and most of PyCharm's
features can be brought to IntelliJ with the free
`Python Plug-In `_. There are two
versions of PyCharm: Professional Edition (Free 30-day trial) and Community
-Edition(Apache 2.0 License) with fewer features.
+Edition (Apache 2.0 License) with fewer features.
Python (on Visual Studio Code)
-----------------------------
From 0b43cd8fce49d1c42317324d88e69332be8ace3b Mon Sep 17 00:00:00 2001
From: He Huang
Date: Tue, 29 Nov 2016 21:22:29 -0500
Subject: [PATCH 064/471] Fixed broken link on Magic Methods with new link and
a brief note. The original website is down.
---
docs/intro/learning.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst
index 823da5bab..97623a8c5 100644
--- a/docs/intro/learning.rst
+++ b/docs/intro/learning.rst
@@ -209,6 +209,8 @@ in Python. Magic methods are surrounded by double underscores (i.e. __init__)
and can make classes and objects behave in different and magical ways.
`A Guide to Python's Magic Methods `_
+Note: The Rafekettler.com is currently down, you can go to their Github version directly. Here you can find a PDF version:
+ `A Guide to Python's Magic Methods (repo on GitHub) `_
For Engineers and Scientists
From 9c33ab68ab94a98012b0666a9ce8a69a10bf8e4f Mon Sep 17 00:00:00 2001
From: He Huang
Date: Tue, 29 Nov 2016 21:27:15 -0500
Subject: [PATCH 065/471] Change the link to Magic Methods from its GitHub repo
to its pdf file directly.
---
docs/intro/learning.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst
index 97623a8c5..f99dd56a0 100644
--- a/docs/intro/learning.rst
+++ b/docs/intro/learning.rst
@@ -210,7 +210,7 @@ and can make classes and objects behave in different and magical ways.
`A Guide to Python's Magic Methods `_
Note: The Rafekettler.com is currently down, you can go to their Github version directly. Here you can find a PDF version:
- `A Guide to Python's Magic Methods (repo on GitHub) `_
+ `A Guide to Python's Magic Methods (repo on GitHub) `_
For Engineers and Scientists
From 48ee67897b44e40143c9c4bca653a01a89dd0bff Mon Sep 17 00:00:00 2001
From: He Huang
Date: Tue, 29 Nov 2016 23:04:15 -0500
Subject: [PATCH 066/471] Format note according to the Style Guide
---
docs/intro/learning.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst
index f99dd56a0..a5e264661 100644
--- a/docs/intro/learning.rst
+++ b/docs/intro/learning.rst
@@ -209,7 +209,7 @@ in Python. Magic methods are surrounded by double underscores (i.e. __init__)
and can make classes and objects behave in different and magical ways.
`A Guide to Python's Magic Methods `_
-Note: The Rafekettler.com is currently down, you can go to their Github version directly. Here you can find a PDF version:
+.. note:: The Rafekettler.com is currently down, you can go to their Github version directly. Here you can find a PDF version:
`A Guide to Python's Magic Methods (repo on GitHub) `_
From e41404737716e74018355a7290750985ea8b5caf Mon Sep 17 00:00:00 2001
From: Nathan Goldbaum
Date: Sun, 4 Dec 2016 13:38:35 -0600
Subject: [PATCH 067/471] typo fix in virtualenv development instructions
---
docs/dev/pip-virtualenv.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/dev/pip-virtualenv.rst b/docs/dev/pip-virtualenv.rst
index 51927e689..07f93c679 100644
--- a/docs/dev/pip-virtualenv.rst
+++ b/docs/dev/pip-virtualenv.rst
@@ -18,8 +18,8 @@ environment of the project. Over time this can result in a messy global package
list.
In order to make sure that you install packages to your active virtual
-environment when you use ``pip install``, consider adding the following two
-lines to your :file:`~/.bashrc` file:
+environment when you use ``pip install``, consider adding the following
+line to your :file:`~/.bashrc` file:
.. code-block:: console
From 61ad4a642fcf79ff1ce74dd57707fad5f462d38a Mon Sep 17 00:00:00 2001
From: Gabbarnama
Date: Tue, 6 Dec 2016 19:43:59 +0530
Subject: [PATCH 068/471] Update structure.rst
Removed hyperlink from setup.py
---
docs/writing/structure.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/writing/structure.rst b/docs/writing/structure.rst
index a156fba7f..0775311c4 100644
--- a/docs/writing/structure.rst
+++ b/docs/writing/structure.rst
@@ -200,7 +200,7 @@ it. You can do this a few ways:
package properly.
I highly recommend the latter. Requiring a developer to run
-`setup.py `__ develop to test an actively changing
+``setup.py develop`` to test an actively changing
codebase also requires them to have an isolated environment setup for
each instance of the codebase.
From 63841bdc50763663b80db585a168ea9bd5f287d1 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Wed, 7 Dec 2016 11:32:47 -0800
Subject: [PATCH 069/471] sierra
---
docs/starting/install/osx.rst | 4 ++--
docs/starting/install3/osx.rst | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index 97baf03d8..67c7aafea 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -6,7 +6,7 @@ Installing Python on Mac OS X
.. note::
Check out our :ref:`guide for installing Python 3 on OS X`.
-The latest version of Mac OS X, El Capitan, **comes with Python 2.7 out of the box**.
+The latest version of Mac OS X, Sierra, **comes with Python 2.7 out of the box**.
You do not need to install or configure anything else to use Python. Having said
that, I would strongly recommend that you install the tools and libraries
@@ -75,7 +75,7 @@ or Python 3:
$ brew install python3
-This will take a minute or two.
+This will take a minute or two.
Setuptools and Pip
diff --git a/docs/starting/install3/osx.rst b/docs/starting/install3/osx.rst
index d5a33291c..456c6d1ec 100644
--- a/docs/starting/install3/osx.rst
+++ b/docs/starting/install3/osx.rst
@@ -3,7 +3,7 @@
Installing Python 3 on Mac OS X
================================
-The latest version of Mac OS X, El Capitan, **comes with Python 2.7 out of the box**.
+The latest version of Mac OS X, Sierra, **comes with Python 2.7 out of the box**.
You do not need to install or configure anything else to use Python 2. These
instructions document the installation of Python 3.
From 96ddd776e0b626968ef7577d76f4231af2a920c3 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Wed, 7 Dec 2016 11:34:28 -0800
Subject: [PATCH 070/471] improvements
---
docs/dev/virtualenvs.rst | 2 +-
docs/starting/install/osx.rst | 2 +-
docs/starting/install3/osx.rst | 6 +++---
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index 927d213fa..c85b8e844 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -44,7 +44,7 @@ This creates a copy of Python in whichever directory you ran the command in,
placing it in a folder named :file:`venv`.
You can also use the Python interpreter of your choice (like
-:file:`/usr/bin/python2.7`).
+``python2.7``).
.. code-block:: console
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index 67c7aafea..6312215a5 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -78,7 +78,7 @@ or Python 3:
This will take a minute or two.
-Setuptools and Pip
+Setuptools & Pip
----------------
Homebrew installs Setuptools and ``pip`` for you.
diff --git a/docs/starting/install3/osx.rst b/docs/starting/install3/osx.rst
index 456c6d1ec..33af41f37 100644
--- a/docs/starting/install3/osx.rst
+++ b/docs/starting/install3/osx.rst
@@ -64,15 +64,15 @@ This will take a minute or two.
Pip
-----------------
+---
Homebrew installs ``pip3`` for you.
``pip3`` is the alias for the Python 3 version of ``pip`` on systems with both
the Homebrew'd Python 2 and 3 installed.
-Working with Python3
---------------------
+Working with Python 3
+---------------------
At this point, you have the system Python 2.7 available, potentially the
:ref:`Homebrew version of Python 2 ` installed, and the Homebrew
From 54ff4fcd59af05ed93e12ccaa2814fc6aec37244 Mon Sep 17 00:00:00 2001
From: David Fischer
Date: Sun, 11 Dec 2016 20:35:43 -0800
Subject: [PATCH 071/471] Click is stable - not upcoming
---
docs/scenarios/cli.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst
index ab357c2fd..617de28c0 100644
--- a/docs/scenarios/cli.rst
+++ b/docs/scenarios/cli.rst
@@ -30,7 +30,7 @@ column printer, iterator based progress bars and implicit argument handling.
Click
-----
-`click `_ is an upcoming Python package for creating
+`click `_ is a Python package for creating
command-line interfaces in a composable way with as little code as
possible. This “Command-line Interface Creation Kit” is highly
configurable but comes with good defaults out of the box.
From 5350bc4d949ecdb050ec8b2681da716b10b59892 Mon Sep 17 00:00:00 2001
From: Bruno Alla
Date: Mon, 12 Dec 2016 13:24:13 +0000
Subject: [PATCH 072/471] Update section about Gondor
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Gondor has changed name, it’s now called
[Eldarion](http://eldarion.cloud). I haven’t used it myself, but I
thought I would update the page.
---
docs/scenarios/web.rst | 17 +++++------------
1 file changed, 5 insertions(+), 12 deletions(-)
diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst
index 9e07a59f5..ecbbbc4b5 100644
--- a/docs/scenarios/web.rst
+++ b/docs/scenarios/web.rst
@@ -221,19 +221,12 @@ how to set up your first application.
Heroku is the recommended PaaS for deploying Python web applications today.
-Gondor
-------
-
-`Gondor `_ is a PaaS specialized for deploying Django
-and Pinax applications. Gondor recommends Django version 1.6 and supports any
-WSGI application on Python version 2.7. Gondor can automatically configure your
-Django site if you use :file:`local_settings.py` for site-specific configuration
-information.
-
-Gondor has a guide on deploying `Django projects `_.
+Eldarion
+--------
-Gondor is run by a small company and focuses on helping businesses find success with
-Python and Django.
+`Eldarion `_ (formely known as Gondor) is a PaaS powered
+by Kubernetes, CoreOS, and Docker. They support any WSGI application and have a
+guide on deploying `Django projects `_.
Templating
::::::::::
From 9c4af31253c9ead770cf179d36d887a34f158c7b Mon Sep 17 00:00:00 2001
From: Nick Klauer
Date: Fri, 16 Dec 2016 13:27:48 -0600
Subject: [PATCH 073/471] Update psutil project page to not use Google Code
Since Google Code is defunct, the new homepage for `psutil` is on GitHub. I've updated the link, nothing more.
---
docs/scenarios/admin.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst
index 8e738d9c0..a438ab40c 100644
--- a/docs/scenarios/admin.rst
+++ b/docs/scenarios/admin.rst
@@ -131,7 +131,7 @@ State files can be written using YAML, the Jinja2 template system or pure Python
Psutil
------
-`Psutil `_ is an interface to different
+`Psutil `_ is an interface to different
system information (e.g. CPU, memory, disks, network, users and processes).
Here is an example to be aware of some server overload. If any of the
From 2d4d8b4dfc7e6d420d29436a2df8801876e6b34c Mon Sep 17 00:00:00 2001
From: Derek Argueta
Date: Sat, 17 Dec 2016 15:59:21 -0700
Subject: [PATCH 074/471] Typo fix
---
docs/starting/which-python.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index b3befa2ed..2d2868e29 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -30,7 +30,7 @@ I'll be blunt:
- Software that is already built often depends on Python 2.7.
- If you are writing a new open source Python library, it's best to write it for both Python 2 and 3
simultaneously. Only supporting Python 3 for a new library you want to be widely adopted is a
- political statment and will alienate many of your users. This is not a problem — slowly, over the next three years, this will become less the case.
+ political statement and will alienate many of your users. This is not a problem — slowly, over the next three years, this will become less the case.
So.... 3?
~~~~~~~~~
From 8ef764dc3e21e111696f9dab0afa27c4d3fe3a49 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Wed, 4 Jan 2017 20:49:44 -0500
Subject: [PATCH 075/471] new japanese translation!
---
docs/_templates/sidebarintro.html | 2 +-
docs/_templates/sidebarlogo.html | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index 28f824998..52c9757a4 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -63,6 +63,6 @@ Translations
English
French
Chinese
- Japanese
+ Japanese
Korean
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
index 64db4c4ae..78f7d7054 100644
--- a/docs/_templates/sidebarlogo.html
+++ b/docs/_templates/sidebarlogo.html
@@ -44,6 +44,6 @@ Translations
English
French
Chinese
- Japanese
+ Japanese
Korean
From cde1e4feed9e59184b3a6458ff806523d995cca2 Mon Sep 17 00:00:00 2001
From: Abhik Pal
Date: Mon, 23 Jan 2017 14:13:07 +0530
Subject: [PATCH 076/471] broken link fix
---
docs/scenarios/scrape.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/scrape.rst b/docs/scenarios/scrape.rst
index 889a93082..90e5252e4 100644
--- a/docs/scenarios/scrape.rst
+++ b/docs/scenarios/scrape.rst
@@ -49,7 +49,7 @@ will focus on the former.
XPath is a way of locating information in structured documents such as
HTML or XML documents. A good introduction to XPath is on
-`W3Schools `_ .
+`W3Schools `_ .
There are also various tools for obtaining the XPath of elements such as
FireBug for Firefox or the Chrome Inspector. If you're using Chrome, you
From 9826b1b82d30336bb8e42208e7e344ae5b169e49 Mon Sep 17 00:00:00 2001
From: Harsh Vardhan
Date: Mon, 23 Jan 2017 17:16:09 +0530
Subject: [PATCH 077/471] Update W3Schools link to the XPath Tutorial.
---
docs/scenarios/scrape.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/scrape.rst b/docs/scenarios/scrape.rst
index 889a93082..90e5252e4 100644
--- a/docs/scenarios/scrape.rst
+++ b/docs/scenarios/scrape.rst
@@ -49,7 +49,7 @@ will focus on the former.
XPath is a way of locating information in structured documents such as
HTML or XML documents. A good introduction to XPath is on
-`W3Schools `_ .
+`W3Schools `_ .
There are also various tools for obtaining the XPath of elements such as
FireBug for Firefox or the Chrome Inspector. If you're using Chrome, you
From 5af55049645e61d50de20105fd2f9b2c74fe217a Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 2 Feb 2017 22:22:23 -0500
Subject: [PATCH 078/471] upgraded sidebar
---
docs/_templates/sidebarintro.html | 3 ++-
docs/_templates/sidebarlogo.html | 3 ++-
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index 52c9757a4..ab0edb3eb 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -33,12 +33,13 @@ Other Projects
More Kenneth Reitz projects:
Contributors
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
index 78f7d7054..e6e3ddc82 100644
--- a/docs/_templates/sidebarlogo.html
+++ b/docs/_templates/sidebarlogo.html
@@ -31,12 +31,13 @@ Other Projects
More Kenneth Reitz projects:
Translations
From 0b1f1d944229f910ce56a1d46fa6721a0ceaac33 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sat, 4 Feb 2017 15:22:40 -0600
Subject: [PATCH 079/471] Update web.rst
---
docs/scenarios/web.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst
index ecbbbc4b5..2bbe36509 100644
--- a/docs/scenarios/web.rst
+++ b/docs/scenarios/web.rst
@@ -1,6 +1,6 @@
-================
-Web Applications
-================
+=============================
+Web Applications & Frameworks
+=============================
As a powerful scripting language adapted to both fast prototyping
and bigger projects, Python is widely used in web application
From 50a60121ad3da0bee92fbd824bea5dd6853a5eff Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Sun, 12 Feb 2017 02:18:02 -0500
Subject: [PATCH 080/471] edmsynths.com
---
docs/_templates/sidebarintro.html | 1 +
docs/_templates/sidebarlogo.html | 1 +
2 files changed, 2 insertions(+)
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index ab0edb3eb..869b3bcf6 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -33,6 +33,7 @@ Other Projects
More Kenneth Reitz projects:
From d6789d22f1942bfba823d865b50928a1c8a63e45 Mon Sep 17 00:00:00 2001
From: Abhishek Kumar Singh
Date: Mon, 10 Apr 2017 20:53:19 +0530
Subject: [PATCH 097/471] Check virtualenv installation, close #657
---
docs/dev/virtualenvs.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index 99b21db2d..71307da50 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -23,6 +23,12 @@ Install virtualenv via pip:
.. code-block:: console
$ pip install virtualenv
+
+Test your installation
+
+.. code-block:: console
+
+ $ virtualenv --version
Basic Usage
~~~~~~~~~~~
From d3d2fcc496984ce16363b6b9fc181628a16197a9 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 13 Apr 2017 10:43:52 -0400
Subject: [PATCH 098/471] python 3 guides
---
docs/starting/install3/linux.rst | 66 +++++++++++++++++++++++++
docs/starting/install3/win.rst | 84 ++++++++++++++++++++++++++++++++
2 files changed, 150 insertions(+)
create mode 100644 docs/starting/install3/linux.rst
create mode 100644 docs/starting/install3/win.rst
diff --git a/docs/starting/install3/linux.rst b/docs/starting/install3/linux.rst
new file mode 100644
index 000000000..9e33ff3c4
--- /dev/null
+++ b/docs/starting/install3/linux.rst
@@ -0,0 +1,66 @@
+.. _install3-linux:
+
+Installing Python 3 on Linux
+============================
+
+This document describes how to install Python 3.6 on Ubuntu Linux machines.
+
+To see which version of Python 3 you have installed, open a command prompt and run
+
+.. code-block:: console
+
+ $ python3 --version
+
+If you are using Ubuntu 16.10 or newer, then you can easily install Python 3.6 with the following commands::
+
+ $ sudo apt-get update
+ $ sudo apt-get install python3.6
+
+If you're using another version of Ubuntu (e.g. the latest LTS release), we recommend using the `deadsnakes PPA `_ to install Python 3.6::
+
+ $ sudo add-apt-repository ppa:fkrull/deadsnakes
+ $ sudo apt-get update
+ $ sudo apt-get install python3.6
+
+
+Setuptools & Pip
+----------------
+
+The two most crucial third-party Python packages are `setuptools `_ and `pip `_.
+
+Once installed, you can download, install and uninstall any compliant Python software
+product with a single command. It also enables you to add this network installation
+capability to your own Python software with very little work.
+
+Python 2.7.9 and later (on the python2 series), and Python 3.4 and later include
+pip by default.
+
+To see if pip is installed, open a command prompt and run
+
+.. code-block:: console
+
+ $ command -v pip
+
+To install pip, `follow the official pip installation guide `_ - this will automatically install the latest version of setuptools.
+
+Virtual Environments
+--------------------
+
+A Virtual Environment is a tool to keep the dependencies required by different projects
+in separate places, by creating virtual Python environments for them. It solves the
+"Project X depends on version 1.x but, Project Y needs 4.x" dilemma, and keeps
+your global site-packages directory clean and manageable.
+
+For example, you can work on a project which requires Django 1.10 while also
+maintaining a project which requires Django 1.8.
+
+To start using this and see more information: :ref:`Virtual Environments ` docs.
+
+You can also use :ref:`virtualenvwrapper ` to make it easier to
+manage your virtual environments.
+
+--------------------------------
+
+This page is a remixed version of `another guide `_,
+which is available under the same license.
+
diff --git a/docs/starting/install3/win.rst b/docs/starting/install3/win.rst
new file mode 100644
index 000000000..d1d00a985
--- /dev/null
+++ b/docs/starting/install3/win.rst
@@ -0,0 +1,84 @@
+.. _install3-windows:
+
+Installing Python 3 on Windows
+============================
+
+First, download the `latest version `_
+of Python 3.6 from the official website. If you want to be sure you are installing a fully
+up-to-date version, click the Downloads > Windows link from the home page of the
+`Python.org web site `_ .
+
+By design, Python installs to a directory with the version number embedded,
+e.g. Python version 3.6 will install at :file:`C:\\Python36\\`, so that you can
+have multiple versions of Python on the
+same system without conflicts. Of course, only one interpreter can be the
+default application for Python file types. It also does not automatically
+modify the :envvar:`PATH` environment variable, so that you always have control over
+which copy of Python is run.
+
+Typing the full path name for a Python interpreter each time quickly gets
+tedious, so add the directories for your default Python version to the :envvar:`PATH`.
+Assuming that your Python installation is in :file:`C:\\Python36\\`, add this to your
+:envvar:`PATH`:
+
+.. code-block:: console
+
+ C:\Python36\;C:\Python36\Scripts\
+
+You can do this easily by running the following in ``powershell``:
+
+.. code-block:: console
+
+ [Environment]::SetEnvironmentVariable("Path", "$env:Path;C:\Python27\;C:\Python27\Scripts\", "User")
+
+This is also an option during the installation process.
+
+The second (:file:`Scripts`) directory receives command files when certain
+packages are installed, so it is a very useful addition.
+You do not need to install or configure anything else to use Python. Having
+said that, I would strongly recommend that you install the tools and libraries
+described in the next section before you start building Python applications for
+real-world use. In particular, you should always install Setuptools, as it
+makes it much easier for you to use other third-party Python libraries.
+
+Setuptools + Pip
+----------------
+
+The most crucial third-party Python software of all is Setuptools, which
+extends the packaging and installation facilities provided by the distutils in
+the standard library. Once you add Setuptools to your Python system you can
+download and install any compliant Python software product with a single
+command. It also enables you to add this network installation capability to
+your own Python software with very little work.
+
+To obtain the latest version of Setuptools for Windows, run the Python script
+available here: `ez_setup.py `_
+
+
+You'll now have a new command available to you: **easy_install**. It is
+considered by many to be deprecated, so we will install its replacement:
+**pip**. Pip allows for uninstallation of packages, and is actively maintained,
+unlike easy_install.
+
+To install pip, run the Python script available here:
+`get-pip.py `_
+
+
+Virtual Environments
+--------------------
+
+A Virtual Environment is a tool to keep the dependencies required by different projects
+in separate places, by creating virtual Python environments for them. It solves the
+"Project X depends on version 1.x but, Project Y needs 4.x" dilemma, and keeps
+your global site-packages directory clean and manageable.
+
+For example, you can work on a project which requires Django 1.10 while also
+maintaining a project which requires Django 1.8.
+
+To start using this and see more information: :ref:`Virtual Environments ` docs.
+
+
+--------------------------------
+
+This page is a remixed version of `another guide `_,
+which is available under the same license.
From 0c97ce5a31f8110910232a68997ee33b5bf92924 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 13 Apr 2017 10:43:58 -0400
Subject: [PATCH 099/471] update python 2 guides
---
docs/starting/install/linux.rst | 20 ++++++++++----------
docs/starting/install/osx.rst | 4 ++--
docs/starting/install/win.rst | 18 ++++++++++--------
3 files changed, 22 insertions(+), 20 deletions(-)
diff --git a/docs/starting/install/linux.rst b/docs/starting/install/linux.rst
index aa56ec07d..c9b779b3d 100644
--- a/docs/starting/install/linux.rst
+++ b/docs/starting/install/linux.rst
@@ -1,9 +1,9 @@
.. _install-linux:
-Installing Python on Linux
-==========================
+Installing Python 2 on Linux
+============================
-The latest versions of CentOS, Fedora, Redhat Enterprise (RHEL) and Ubuntu
+The latest versions of CentOS, Fedora, Redhat Enterprise (RHEL) and Ubuntu
**come with Python 2.7 out of the box**.
To see which version of Python you have installed, open a command prompt and run
@@ -32,11 +32,11 @@ Setuptools & Pip
The two most crucial third-party Python packages are `setuptools `_ and `pip `_.
-Once installed, you can download, install and uninstall any compliant Python software
-product with a single command. It also enables you to add this network installation
+Once installed, you can download, install and uninstall any compliant Python software
+product with a single command. It also enables you to add this network installation
capability to your own Python software with very little work.
-Python 2.7.9 and later (on the python2 series), and Python 3.4 and later include
+Python 2.7.9 and later (on the python2 series), and Python 3.4 and later include
pip by default.
To see if pip is installed, open a command prompt and run
@@ -50,15 +50,15 @@ To install pip, `follow the official pip installation guide ` docs.
+To start using this and see more information: :ref:`Virtual Environments ` docs.
You can also use :ref:`virtualenvwrapper ` to make it easier to
manage your virtual environments.
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index 6312215a5..f0851d380 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -1,7 +1,7 @@
.. _install-osx:
-Installing Python on Mac OS X
-=============================
+Installing Python 2 on Mac OS X
+===============================
.. note::
Check out our :ref:`guide for installing Python 3 on OS X`.
diff --git a/docs/starting/install/win.rst b/docs/starting/install/win.rst
index 6496a3a78..bbcae9ccb 100644
--- a/docs/starting/install/win.rst
+++ b/docs/starting/install/win.rst
@@ -1,10 +1,10 @@
.. _install-windows:
-Installing Python on Windows
-============================
+Installing Python 2 on Windows
+==============================
-First, download the `latest version `_
-of Python 2.7 from the official Website. If you want to be sure you are installing a fully
+First, download the `latest version `_
+of Python 2.7 from the official website. If you want to be sure you are installing a fully
up-to-date version, click the Downloads > Windows link from the home page of the
`Python.org web site `_ .
@@ -35,6 +35,8 @@ You can do this easily by running the following in ``powershell``:
[Environment]::SetEnvironmentVariable("Path", "$env:Path;C:\Python27\;C:\Python27\Scripts\", "User")
+This is also an option during the installation process.
+
The second (:file:`Scripts`) directory receives command files when certain
packages are installed, so it is a very useful addition.
You do not need to install or configure anything else to use Python. Having
@@ -69,15 +71,15 @@ To install pip, run the Python script available here:
Virtual Environments
--------------------
-A Virtual Environment is a tool to keep the dependencies required by different projects
-in separate places, by creating virtual Python environments for them. It solves the
-"Project X depends on version 1.x but, Project Y needs 4.x" dilemma, and keeps
+A Virtual Environment is a tool to keep the dependencies required by different projects
+in separate places, by creating virtual Python environments for them. It solves the
+"Project X depends on version 1.x but, Project Y needs 4.x" dilemma, and keeps
your global site-packages directory clean and manageable.
For example, you can work on a project which requires Django 1.10 while also
maintaining a project which requires Django 1.8.
-To start using this and see more information: :ref:`Virtual Environments ` docs.
+To start using this and see more information: :ref:`Virtual Environments ` docs.
--------------------------------
From ef35770716f6a32afb0ddaa3bd8c074c1bfe769e Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 13 Apr 2017 10:46:45 -0400
Subject: [PATCH 100/471] update installation
---
docs/starting/installation.rst | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/docs/starting/installation.rst b/docs/starting/installation.rst
index 55114b21d..83d4ad1bd 100644
--- a/docs/starting/installation.rst
+++ b/docs/starting/installation.rst
@@ -16,7 +16,12 @@ Installation Guides
These guides go over the proper installation of :ref:`Python `
for development purposes, as well as setuptools, pip and virtualenv.
-- :ref:`Python 3 on MacOS `.
+- :ref:`Python 3 on MacOS `
+- :ref:`Python 3 on Windows `.
+- :ref:`Python 3 on Linux `.
+
+--------------------------------
+
- :ref:`Python 2 on MacOS `.
- :ref:`Python 2 on Microsoft Windows `.
- :ref:`Python 2 on Ubuntu Linux `.
From fd8cce0708f933c4c0dbfdfebd8d1211b11aa517 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 13 Apr 2017 10:49:47 -0400
Subject: [PATCH 101/471] fix contents
---
docs/contents.rst.inc | 3 +++
docs/starting/installation.rst | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc
index 22cbdc940..b5673cc92 100644
--- a/docs/contents.rst.inc
+++ b/docs/contents.rst.inc
@@ -14,6 +14,9 @@ New to Python? Let's properly setup up your Python environment.
:maxdepth: 1
starting/installation
+ starting/install3/osx
+ starting/install3/win
+ starting/install3/linux
starting/install/osx
starting/install/win
starting/install/linux
diff --git a/docs/starting/installation.rst b/docs/starting/installation.rst
index 83d4ad1bd..1fe651956 100644
--- a/docs/starting/installation.rst
+++ b/docs/starting/installation.rst
@@ -18,7 +18,7 @@ for development purposes, as well as setuptools, pip and virtualenv.
- :ref:`Python 3 on MacOS `
- :ref:`Python 3 on Windows `.
-- :ref:`Python 3 on Linux `.
+- :ref:`Python 3 on Linux `.
--------------------------------
From 7096c951326ae691fe3f7bd88596570dcff40ca5 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 13 Apr 2017 10:51:59 -0400
Subject: [PATCH 102/471] syntax
---
docs/starting/installation.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/starting/installation.rst b/docs/starting/installation.rst
index 1fe651956..36bf6898d 100644
--- a/docs/starting/installation.rst
+++ b/docs/starting/installation.rst
@@ -16,7 +16,7 @@ Installation Guides
These guides go over the proper installation of :ref:`Python `
for development purposes, as well as setuptools, pip and virtualenv.
-- :ref:`Python 3 on MacOS `
+- :ref:`Python 3 on MacOS `.
- :ref:`Python 3 on Windows `.
- :ref:`Python 3 on Linux `.
From 9164a1b1e91084cf8873fd07da12fbd39e4ca29d Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 13 Apr 2017 10:53:18 -0400
Subject: [PATCH 103/471] working with python 3
---
docs/starting/install3/linux.rst | 18 ++++++++++++++++++
docs/starting/install3/osx.rst | 2 +-
docs/starting/install3/win.rst | 18 ++++++++++++++++++
3 files changed, 37 insertions(+), 1 deletion(-)
diff --git a/docs/starting/install3/linux.rst b/docs/starting/install3/linux.rst
index 9e33ff3c4..eee5620ad 100644
--- a/docs/starting/install3/linux.rst
+++ b/docs/starting/install3/linux.rst
@@ -22,6 +22,23 @@ If you're using another version of Ubuntu (e.g. the latest LTS release), we reco
$ sudo apt-get update
$ sudo apt-get install python3.6
+Working with Python 3
+---------------------
+
+At this point, you have the system Python 2.7 available, potentially the
+:ref:`Homebrew version of Python 2 ` installed, and the Homebrew
+version of Python 3 as well.
+
+.. code-block:: console
+
+ $ python
+
+will launch the Python 2 interpreter.
+
+.. code-block:: console
+
+ $ python3
+
Setuptools & Pip
----------------
@@ -59,6 +76,7 @@ To start using this and see more information: :ref:`Virtual Environments ` to make it easier to
manage your virtual environments.
+
--------------------------------
This page is a remixed version of `another guide `_,
diff --git a/docs/starting/install3/osx.rst b/docs/starting/install3/osx.rst
index de0d4b396..8a8282277 100644
--- a/docs/starting/install3/osx.rst
+++ b/docs/starting/install3/osx.rst
@@ -90,7 +90,7 @@ will launch the Python 2 interpreter.
$ python3
-will launch the Python 3 interpreter
+will launch the Python 3 interpreter.
``pip3`` and ``pip`` will both be available. If the Homebrew version of Python
2 is not installed, they will be the same. If the Homebrew version of Python 2
diff --git a/docs/starting/install3/win.rst b/docs/starting/install3/win.rst
index d1d00a985..c940b9beb 100644
--- a/docs/starting/install3/win.rst
+++ b/docs/starting/install3/win.rst
@@ -41,6 +41,24 @@ described in the next section before you start building Python applications for
real-world use. In particular, you should always install Setuptools, as it
makes it much easier for you to use other third-party Python libraries.
+Working with Python 3
+---------------------
+
+At this point, you have the system Python 2.7 available, potentially the
+:ref:`Homebrew version of Python 2 ` installed, and the Homebrew
+version of Python 3 as well.
+
+.. code-block:: console
+
+ $ python
+
+will launch the Python 2 interpreter.
+
+.. code-block:: console
+
+ $ python3
+
+
Setuptools + Pip
----------------
From a8ed45d5c402bdef16e8f6cb309b0a7b001d97a8 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 13 Apr 2017 10:58:14 -0400
Subject: [PATCH 104/471] fixes
---
docs/starting/install3/linux.rst | 7 +++----
docs/starting/install3/win.rst | 8 ++++----
2 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/docs/starting/install3/linux.rst b/docs/starting/install3/linux.rst
index eee5620ad..f9171bcfc 100644
--- a/docs/starting/install3/linux.rst
+++ b/docs/starting/install3/linux.rst
@@ -25,20 +25,19 @@ If you're using another version of Ubuntu (e.g. the latest LTS release), we reco
Working with Python 3
---------------------
-At this point, you have the system Python 2.7 available, potentially the
-:ref:`Homebrew version of Python 2 ` installed, and the Homebrew
-version of Python 3 as well.
+At this point, you may have system Python 2.7 available as well.
.. code-block:: console
$ python
-will launch the Python 2 interpreter.
+This will launch the Python 2 interpreter.
.. code-block:: console
$ python3
+This will launch the Python 3 interpreter.
Setuptools & Pip
----------------
diff --git a/docs/starting/install3/win.rst b/docs/starting/install3/win.rst
index c940b9beb..4a7aadd6f 100644
--- a/docs/starting/install3/win.rst
+++ b/docs/starting/install3/win.rst
@@ -44,20 +44,20 @@ makes it much easier for you to use other third-party Python libraries.
Working with Python 3
---------------------
-At this point, you have the system Python 2.7 available, potentially the
-:ref:`Homebrew version of Python 2 ` installed, and the Homebrew
-version of Python 3 as well.
+At this point, you may also have Python 2.7 installed.
.. code-block:: console
$ python
-will launch the Python 2 interpreter.
+This will launch the Python 2 interpreter.
.. code-block:: console
$ python3
+This will launch the Python 3 interpreter.
+
Setuptools + Pip
----------------
From 83d1fd49d521f2b2c7b1f79050c9f98eee52e96c Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 13 Apr 2017 11:00:51 -0400
Subject: [PATCH 105/471] fixes
---
docs/starting/install/osx.rst | 2 +-
docs/starting/install3/osx.rst | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index f0851d380..24eb27437 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -14,7 +14,7 @@ described in the next section before you start building Python applications for
real-world use. In particular, you should always install Setuptools, as it makes
it much easier for you to install and manage other third-party Python libraries.
-The version of Python that ships with OS X is great for learning but it's not
+The version of Python that ships with OS X is great for learning, but it's not
good for development. The version shipped with OS X may be out of date from the
`official current Python release `_,
which is considered the stable production version.
diff --git a/docs/starting/install3/osx.rst b/docs/starting/install3/osx.rst
index 8a8282277..8844f2e1f 100644
--- a/docs/starting/install3/osx.rst
+++ b/docs/starting/install3/osx.rst
@@ -10,7 +10,7 @@ The latest version of Mac OS X, Sierra, **comes with Python 2.7 out of the box**
You do not need to install or configure anything else to use Python 2. These
instructions document the installation of Python 3.
-The version of Python that ships with OS X is great for learning but it's not
+The version of Python that ships with OS X is great for learning, but it's not
good for development. The version shipped with OS X may be out of date from the
`official current Python release `_,
which is considered the stable production version.
From d3e97f2ec1ae42bd4bae48b11ad32e21a071cb9d Mon Sep 17 00:00:00 2001
From: Dmytro Brykovets
Date: Sat, 15 Apr 2017 12:34:19 +0300
Subject: [PATCH 106/471] Remove junk in Jinja code block
The "
From 6e0c78df7b2693c8937bafe58c8b856c1e2bdc39 Mon Sep 17 00:00:00 2001
From: monchitos
Date: Tue, 18 Apr 2017 10:02:15 -0500
Subject: [PATCH 107/471] Adding a reminder for preventing a misuse of the
example in "common gotchas/mutable default arguments"
---
docs/writing/gotchas.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/writing/gotchas.rst b/docs/writing/gotchas.rst
index f8e2e2377..fcf143943 100644
--- a/docs/writing/gotchas.rst
+++ b/docs/writing/gotchas.rst
@@ -76,6 +76,7 @@ signal that no argument was provided (:py:data:`None` is often a good choice).
to.append(element)
return to
+Do not forget, you are passing a *list* object as the second argument.
When the Gotcha Isn't a Gotcha
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
From a3055ae6b6ad6cfcdf92573513a54195922a4579 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 27 Apr 2017 17:42:17 -0400
Subject: [PATCH 108/471] sponsor
---
docs/_templates/sidebarintro.html | 5 +++++
docs/_templates/sidebarlogo.html | 7 +++++++
2 files changed, 12 insertions(+)
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index 81272b5ec..08ebba00c 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -21,6 +21,11 @@ Stay Informed
Join Mailing List.
Say Thanks!
+Sponsor
+
+
+
+
O'Reilly Book
This guide is now available in tangible book form!
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
index 45f447a0a..688c9f91e 100644
--- a/docs/_templates/sidebarlogo.html
+++ b/docs/_templates/sidebarlogo.html
@@ -19,6 +19,11 @@ Get Updates
Say Thanks!
Join Mailing List.
+Sponsor
+
+
+
+
O'Reilly Book
This guide is now available in tangible book form!
@@ -27,6 +32,8 @@ O'Reilly Book
All proceeds are being directly donated to the DjangoGirls organization.
+
+
Other Projects
More Kenneth Reitz projects:
From a094400701a49685797cbe2d0f4af245ba7c93e8 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 27 Apr 2017 17:46:12 -0400
Subject: [PATCH 109/471] tweaks
---
docs/_templates/sidebarintro.html | 2 +-
docs/_templates/sidebarlogo.html | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index 08ebba00c..036d0cb63 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -23,7 +23,7 @@ Stay Informed
Sponsor
-
+
O'Reilly Book
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
index 688c9f91e..9e91c1c3a 100644
--- a/docs/_templates/sidebarlogo.html
+++ b/docs/_templates/sidebarlogo.html
@@ -21,7 +21,7 @@ Get Updates
Sponsor
-
+
O'Reilly Book
From 7f118fc3d042dd6fd2e6569f61477c285ba3f0f7 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 27 Apr 2017 17:51:06 -0400
Subject: [PATCH 110/471] changes
---
docs/_templates/sidebarintro.html | 6 ++++--
docs/_templates/sidebarlogo.html | 5 +++--
2 files changed, 7 insertions(+), 4 deletions(-)
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index 036d0cb63..7927c6953 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -21,11 +21,13 @@ Stay Informed
Join Mailing List.
Say Thanks!
-Sponsor
+
-
+
+
+
O'Reilly Book
This guide is now available in tangible book form!
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
index 9e91c1c3a..73c6c2dc2 100644
--- a/docs/_templates/sidebarlogo.html
+++ b/docs/_templates/sidebarlogo.html
@@ -19,11 +19,12 @@ Get Updates
Say Thanks!
Join Mailing List.
-Sponsor
-
+
+
+
O'Reilly Book
This guide is now available in tangible book form!
From 39d7cbfebb1a859b876bf9aa1a9adb6218347a20 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 27 Apr 2017 17:53:14 -0400
Subject: [PATCH 111/471] ad placement
---
docs/_static/ad.png | Bin 0 -> 40171 bytes
docs/_templates/sidebarintro.html | 2 +-
docs/_templates/sidebarlogo.html | 2 +-
3 files changed, 2 insertions(+), 2 deletions(-)
create mode 100644 docs/_static/ad.png
diff --git a/docs/_static/ad.png b/docs/_static/ad.png
new file mode 100644
index 0000000000000000000000000000000000000000..48a78947a480b09bd69cfdf0f9e88602edfd9f15
GIT binary patch
literal 40171
zcmV)6K*+y|P)NvQKKr
zQ)Q!3)aYksO1e#F%C;vzMmGY*LctYIX?$~ou9((vW@otc3@yMZ{fJP)up)y|^=l^U
z(zE9}C$$iUm1@&q&YDy8@QK)w>g}=1Om;tp-K&^-e&CemSw<7CW7zJgx*^|l*cAo`
z;=7;EyUg7A@%xgkBaT4f)CrgCIpSP#$mmjVy)GrKAv>?DOmj#W)`-KI98m8F6veCt
z5A82ayv*!*E;DCdy{EVIaRsgXP=TcSS7(gGUa!wywn`4I*J!E%r1Ki;MjyT&A;2Ju6o~TCA(Xx?>`Jbd@~OJ1rO%
z>L9B>Qe&AUB{gQC`=s;CY}kM#8)}b0u@FdBItoVBHh*DB1!VEd9qBfvh4j_7aH+Lb
zt{~QKKG{0~BfyH2hiMJ!C7EJ`2wz50rKdU}Mdd?>ORBBneq`57=?{s^oHBX=6RLj%
z3No?SLLkX1%B*N1rMZ*s6ay0#v1_qth$^0dZA<=})DZ~vjj1JE*@$7YO3MI^q-FMp
z&IOY?lB2nJzW12=eZr+?cDPK(Y%!v&7*(&!_sLcmN{y))n_OzfOjkT98_e-zF4cG3
zBrwLHI56PyCwmPJlkJ@EQZo|RN#*k>3(Il-8UKv?vLx6!V8#|rx<5TC1DgUXg|=GqMQvm
z*<(`2kCx8m_*~CX*S2V8N!_Vz<8=K!o$A+u~V91t(evBUbwQ;9qG@x
zAMERK#|HA1_d5lC+vAu5{hYpC%!{GGtjw#KPMM?yv%+STm6Vuj7qh8BY3=8)Ac-m$
zGAkHfN{r0Ovxs*wf4s+K<|UrQ=r95g;*Blfw2%~42@NS?cxOA5X|sIo@4Ib?p}8y*ZTGZR%2G>w#Cc!Fj`v&
z1kOQUo$y|n4tdJ_l4sLs>i)-l!BAi@CLMBLf+*mnf(cdLr{S^kfhv>E3i}qZ+od%w
z?JzDGjO|XSnUX{qDbZ9C7y?IPUsF#8JU3nGmE>58@4!T0VGapFr8|nqE@P#Xm|UDQoa>x68_l*ieR5
z)Jl~*cBt&3VzkW8?UFHebRfbuiRKqCob6sDmG4|hPzO&9x;ystxW9a4k2@q4u#&n@
z<=mII9kxGI#cP+(bFV*piTkzl((aMNC&avt>9fzZD(|YipH}*9l2xQbNFSNW1^P#N
zGxo1V8QD$c5Ti=ZtfKabsSPrxbY|%U{E~JJgc)F
zc-Aefi)pQ#-R@qoy31WDiK;(eaCh!I?*4gmx7*z}9A(^*NxLpdR{28F?LR5kXZU#c
zoEUKb`piN5TPum|x)q)7?dL6XFhQiUZ|pqc_MT9GbzVXvj{s7HbCRq=LTZ=}lv3zN
zsxL6Evx1vzJt7@(kGbPVj9Hn=C>vC{w@=!HjO{r|X=b!Xqo|NPjiK>gh#0pdgvy4Z
z>_3=RyKq)8CDdtNWX1`G1u<@BKFQ@9$FOoog;s@GX{E{fFa;SMxiA+)98R~Z1Gp(`
z&^1!)E?qR+{n>-N+*8M7GpRx_wl{BB;&Ng-ZJH>D`v=`WK6SwL4wl=lwjS?yTc14O
z{y~2m=Xbc@y=aBC`0rZ|nX$e~^9|n&^MoSPxNEz*IE<1Y!H=q#8PK$%Y
zk%o_BBO6S~kegkgIdtrxsUQPlTJ4LLso#M;(M%gaG;|-Ra$tkXNs^gDwz4uF=fspy
zFM%}p;|%$)Hc_FGs@mqugWBR_Qht9E_)BBX7{zf1)blotKLSxhW|SFZrE|g&OUx>~
zR~}$SF5#k>8KT`tgzASOy&ALXY|psg5!3m?_2-yZ@J}Dy?f&-zJEbz_+@D@?ru&tR
zOC6F|9Bop&Ps=dBN75RMZXzkybI5e{iM(dRuBG>v5Sy$*B(hOkPvr&lV&-IE9yqvH
z2=KjT%d9-4)qZ2lZIeo3J`X%n5%6dJM4xpxtpIb+gyQ;dUcxZFk4akLK_!HIHlu3{
zp}6DPNVe4;0i>*~=3xArUHjZ&dktKttrjA!Z()?_{F_w35BzwCJ6BTF&DWe&wGG-veT<$PcddqRgFj9zk8JoYjMQNM
zRN!&5f+3IleV43q=gR>9{(HB(Zb@Q4+<)BR9R$LFx3Fh0?>_qQZg)~A;1L)mwN8yOM*263Fe}3asrxCISRHCyDJ;q3hG-DASX64?ekK2n
zWdzJ&A>LC5!;+X!*n%N}t6!?92g~YWF#C$b47=ijNkIri2n8!YO6SAKdfJz`nSwE7
z^{jJ|`3{`ndKu4m3es@vcHx(F_A1%2zIek1_u#=k_nUWZv29tkb3{xJW>!hF+Z3~;
zNd(Ze&_ssCJvuRSLOf0<;(l?m;O&9Zv!(|0fsCz?X0UzoA34T?&!KI$p~`=LIu)bL
zE!?P?UFED~bG;*g^8y-?Vdah-5{M4bSQ8MS7r-u<6RMpgD-4qm%xZ9;TZ@sTB~4ts
zgdkW8vICT1Ds(JNEs&`6AT=LM+R`-$hCJH6Uxv4JZnh+$C~|$(>=|x{nAImA-CLSg
zcoFx?9u@TvB4sU*oeOBg0jYjbn%|B`(aA8cfY$ovVf6I6zniV@G-Oy#Qg^$Iqda#E
z+8*pz_rOiofuYSaKvgp_#KO=ZG?z_-08{AIyDEJI>H(G1Kz%RZe1N1uOcgR9t?q?)
zeY8-dX5M36!OvhuU{5ir_Q0%^
z0rRXeNpixooD|anI@%CK`qX-G?)oZ@}WQqB#lN9#yGrL??Qq;*9
zr2FETZBiYZ%dD(xV(55=PD|2@KK$9X_DGZrb$Yf!F{1i?cn1~(
zr0>|TGI&Yw1Zs6Hi9q3TxboSbN2k|=D-xwG4qi?&ZVJOPD2CNHFz6P@sJ^3j2z&Lk
zAP)1y#LnrQS>{2+CiRXBmMbi$-(4fHC}?*iuQ(gkQW@L-+pfFA)fcZA++!%&6H
ziv1Zu7Ep1K{5g(v)Wb;33fK;6Fj5#^aZhOlOB3ml*UO(fdeBha(f$6oR{6~9KBL5a
zBWSb&d1<{S!x~9S@M0PqYT%$UO=57w7A3DrM)nKK?R4_EeGW)<^dcr8(|8J`k{&UY
zMUsZ1gsS%~h1&f2v)8zNQuRLZ@E-T1!f$3t-2R2LB>hEbhD7`~p0mV#@ctdLRSoS}
z)-ha79NOEsZw7j+VDK>YLMGA~E+<@CN=!bL8d4ds;}yvLQ*nOddY821N5Gg7%u4HM
zc5aL`p=Ur&CU9CvA1tQC3#Q47rALY6gk*)&$*@|6vr=Q8^e&Kyv8Z;)mjz>M6GLoO
zEM7`@vS{|yR_Z6r9|gN6!}1+2_DgCa;I)E0ygn0Z0q?)!%6^Rl^
zd2CiuiE61J4dAevO@`~KxJX75e~2vwI}OuRF|2?z+x3@F^GBfM*<+EV;6V(b;$=G*
z8SvQ{l#uVCWvX;EkpKivSHo&$)OJvH3ENoZEGRWI>0gi_<@1->Mm9SwoEbE$79pfp
z!(!Fy4-XOJquHh^43FmdgOQ1N2${K^W#VwDUG^!Yfx3AHuLl;PwrI1=)*;c_Jdrx_
zpaif*f-6+gaYiIyFF6DcSbBS?ZvmT+rr9v>p$zP#lnvt0#MGn`wJlm2
zsE%S<7BGqg7RFu?kA>$ECU#K9^|hTtwt#3K@%(*HDP-Otm9G}T+$w3FBrZIPW1#?p
z7MyFIBi-L*l2CDWc>^kHQSdtcWcFz)UYp2_0ohfV(>R34v|yPTr2YXIMdCH$WtO(!
zTn(EJ#&>~balxmwK&O>u)S^Iud8pm#QjlY^o-=CUa51K$H^c^}6luPh&nZFAX5F|ks^$8Q@
zey1FX=@UyhBE#aw(BTIU?=uDy+-Q&rH>X-{#(l(SAS5K)CMzb;1(+9%s3@r^Mc}iD
zLzxof!O2T%Gu#JYL$*mAMN&H~yVUF&*p;<&Bd%jRGx+a6wj6Y~Y&!&s#yxfrB@+c!8O#-nNRA&wRzu
zjuCqB@O~NEWz!*BL&S^7c-TTN528G&7TOrz#Mh^Tl{BUleZ)B&7@i&T)kO3T)O`
zQp%XIPYkvpBu^^XH734gxNJzHNh9MM0T$qeVon1AW04jCQQaF5aN(44S@FV?+pS_A
zP<+BvK+SbjKC+5xc1xX{V}NMOTq=e&nS{+aN(EJ9%EbE^qK8fB_dsxwfFoYviV`{C
z4`_E<0Dy#GW-?D~J-xC#HH7Avcocx-0uKw~5^_sGCN}HA@sRRz;aV9V?TVs*Q#zhA
zOoWz%<%t!F;Ardw*q;cY0b_LvCKw@tm&qbpNu0B*uex1nrI7M*cCE^GlHaH22=IdN
z7bPTD%o#-)-7PC-OzAbx3@pucxET93Sd=myb;$(&l%{+Jm3@ZZnaPy)hTkB7ad<^k
z&>(JEDUy%reGYk!J&XCu7BakniY>wk4Td%;vN2Hp2&t%)GMB?)S~M(XMbduMLcnqm
zt4_4q2!Yd(Kc9R;8LdErN0j%v_o$!|?QTF5=TWJ2A9?l~K^gYDyCQLcq@5vduwEi2
z@l|UU3ahoq@@3U~Uek_?F!-ijBWbvyBj9a=Fel6&o-YL|q~tSwY;bvO
za9aGaVfp)sZC#QK>CGt+F%ek6yliX6tn{9Oaf25i(h$;T+x5N}v!ePl;a=x`>4AWQ
z#P(kINSKWblDL4g3xeu#^ma%~(f2f#$`^3I7gnYGgnzJsuj8ub51L6!scdKgUzm!Qo_NZ67fyx
zuNdfn_yL#0JW?42;G+;w1=|)cGl6IXh9w4bfMDZ-N=275C03U~(=Da4X>~#RLg%bT
zFgf!cTKWwQhL~S@W(QsCV8G1Ux|Zr?4#aaLq*qEp`q{M$P3roGC-+-=<7(Go`&sj5
zy0@LX)WD}?A^rYd6~mlFA`~en>CqcuGk8Vyuq;Fg#;x!N%O$1SNSri}&RL4;Zwl76rb}b1w0|)kKld=jMzmU*W
zc0k1sY*0v1<~6DCj+h~yFp`rP+QFabg_IhIvAs;>lr&|WGE@<{L<%p3&MhZGdghp<
zg(#Q_85SvK{&VXg_e}*o|Kiz;-6x*2)(T4e>oeWM(jjAzf1@O-XD^xSZdER<|Im43
zF|wEUYwW*J9|}Msl-Q0jGDNg&B8DPn%t&~rdUe?DkiKAAtrEL6_Pd^*XJXoz?l>w`
zuQICqUAA-lKfJ^mwQ-lVDnSTdfpAn5=2L5XZHDFDyd>+7BOhh}CoU*H5W_h&*btEc
zgy#EY_3y*j7wDnr&r}borUDU12k5|u{6wz_9O2WC?{i-jBYMlmCGIoNJIff^SCt!!
z8$klQNq_gNCgE?~xn&s2J=)epd^aW}bsF^#kv1(xRVINVm5M>L7yvf3)rP$Hf_MyL
z`V-ONL7th`l(0(ulr#`WhOG*n
z4{ZyUN@7qd4qiS{8~@4l%B!?xklaXjL5R
zNPph_;e9*Y<{E`7MrylJ`^}@ogBQW1(qi6zz$>r8LqmTr>bSh()I8I-5D9aUSDuml
zPDY?PBY?fRoua;&Z9-^AbFLJ$YDH=E?pmmx!k#>=$zL<47-Unyk+eb_XHACXC7!%W
z8O5oEUX(MgEd9P9i3-)Hl8RFCa&(NeG9rKRvg5=}!L-sUt7}%*y(2un#TN
zf=q!dNJ~r0w988IbWm?dw$^CY
zI-!iC0)c|ZBB0r$fJ?{dB{mNtqLDg++GG+Lb{^TT+EjX}mEFYtK9bL51d