From 580e32fb6a0fea5c34677899f7cd215a6a54fd95 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 01:21:46 -0700
Subject: [PATCH 001/992] Update Buildbot URL.
---
docs/scenarios/ci.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index 3a80c70b3..d9fc431ab 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -26,7 +26,7 @@ engine. Use it.
Buildbot
--------
-`Buildbot `_ is a Python system to
+`Buildbot `_ is a Python system to
automate the compile/test cycle to validate code changes.
@@ -85,4 +85,4 @@ thorough.
In order to activate testing for your project, go to `the travis-ci site `_
and login with your Github account. Then activate your project in your profile settings and that's
-it. From now on, your project's tests will be run on every push to Github.
+it. From now on, your project's tests will be run on every push to Github.
From 5609bc8bbff2189e1659f47039f218ae34cac271 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 01:22:47 -0700
Subject: [PATCH 002/992] Update tox URL.
---
docs/scenarios/ci.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index d9fc431ab..1bb2af534 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -38,7 +38,7 @@ Mule?
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:
From 5982ec650a64210a831971771497315db286fab5 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 01:23:15 -0700
Subject: [PATCH 003/992] Update Travis CI URL because always https.
---
docs/scenarios/ci.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index 1bb2af534..6e2025d91 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -53,7 +53,7 @@ which provides the following features:
Travis-CI
---------
-`Travis-CI `_ is a distributed CI server which builds tests
+`Travis-CI `_ is a distributed CI server which builds tests
for open source projects for free. It provides multiple workers to run Python tests
on and seamlessly integrates with Github. You can even have it comment on your Pull
Requests whether this particular changeset breaks the build or not. So if you are
@@ -83,6 +83,6 @@ notifications, before and after steps and much more. The
`travis-ci docs `_ explain all of those and are very
thorough.
-In order to activate testing for your project, go to `the travis-ci site `_
+In order to activate testing for your project, go to `the travis-ci site `_
and login with your Github account. Then activate your project in your profile settings and that's
it. From now on, your project's tests will be run on every push to Github.
From 920aa3725c88a82101ad29502e8a8b4242bfbf9f Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 01:26:15 -0700
Subject: [PATCH 004/992] Use Wayback Machine to resolve a dead link.
---
docs/scenarios/db.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/db.rst b/docs/scenarios/db.rst
index 5d12c2a51..6d6d6ce7a 100644
--- a/docs/scenarios/db.rst
+++ b/docs/scenarios/db.rst
@@ -11,7 +11,7 @@ Nearly all Python database modules such as `sqlite3`, `psycopg` and
Tutorials that explain how to work with modules that conform to this interface can be found
`here `__ and
-`here `__.
+`here `__.
SQLAlchemy
----------
From c52c9187ae4dc9b7436a15426f8fda8f1eda5a12 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 01:27:22 -0700
Subject: [PATCH 005/992] Add Qt link.
---
docs/scenarios/gui.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/gui.rst b/docs/scenarios/gui.rst
index 7f502b37d..94b190345 100644
--- a/docs/scenarios/gui.rst
+++ b/docs/scenarios/gui.rst
@@ -4,7 +4,7 @@ GUI Applications
Qt
--
-Qt is a cross-platform application framework that is widely used for developing
+`Qt `_ is a cross-platform application framework that is widely used for developing
software with a GUI but can also be used for non-GUI applications.
PySide
From 1e38672e668a6c629d8154ce5dfab95fa7a55131 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 11:42:32 -0700
Subject: [PATCH 006/992] Update Gunicorn help link.
---
docs/scenarios/web.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst
index 588dbb285..dd6418bc1 100644
--- a/docs/scenarios/web.rst
+++ b/docs/scenarios/web.rst
@@ -152,7 +152,7 @@ lightweight, easy to use, and uses many UNIX idioms. Gunicorn is not designed
to face the internet -- it was designed to run behind Nginx which buffers
slow requests and takes care of other important considerations. A sample
setup for Nginx + Gunicorn can be found in the
-`Gunicorn help `_.
+`Gunicorn help `_.
.. _uwsgi-ref:
From 0b897088fcde12b99d5b1727b0b9f664105d8e92 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 11:44:32 -0700
Subject: [PATCH 007/992] Update link to Gondor documentation.
---
docs/scenarios/web.rst | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst
index dd6418bc1..99b3dfc6b 100644
--- a/docs/scenarios/web.rst
+++ b/docs/scenarios/web.rst
@@ -235,9 +235,7 @@ and Pinax applications. Gondor supports Django versions 1.2 and 1.3 on
Python version 2.7, and can automatically configure your Django site if you
use ``local_settings.py`` for site-specific configuration information.
-Gondor publishes guides to deploying `Django projects
-`_ and `Pinax projects
-`_ on their platform.
+Gondor has a guide on deploying `Django projects `_.
Templating
From c5e37675ce06ed310560a254d7f672c8ae0b6eca Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 11:49:59 -0700
Subject: [PATCH 008/992] Update virtualenvwrapper documentation links.
---
docs/dev/virtualenvs.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index ee6ace244..c08f1118e 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -60,7 +60,7 @@ where they were placed.
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.
@@ -72,7 +72,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-powershell `_ clone.
@@ -136,7 +136,7 @@ Other useful commands
``lssitepackages``
Shows contents of ``site-packages`` directory.
-`Full list of virtualenvwrapper commands `_.
+`Full list of virtualenvwrapper commands `_.
autoenv
-------
From 8bd2c129658fd3bfd48e1b60f5bf6f3d1a4a5a46 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 11:54:40 -0700
Subject: [PATCH 009/992] Update link to 'A Byte of Python'.
---
docs/intro/learning.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst
index 63d6d04fb..27e770def 100644
--- a/docs/intro/learning.rst
+++ b/docs/intro/learning.rst
@@ -85,7 +85,7 @@ A free introductory book that teaches python at the beginner level, it assumes n
previous programming experience.
`A Byte of Python for Python 2.x `_
- `A Byte of Python for Python 3.x `_
+ `A Byte of Python for Python 3.x `_
Advanced
@@ -130,7 +130,7 @@ A Primer on Scientific Programming with Python
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A Primer on Scientific Programming with Python, written by Hans Petter Langtangen,
-mainly covers python's usage in scientific field. In the book, examples are
+mainly covers python's usage in scientific field. In the book, examples are
choosen from mathematics and the natural sciences.
`A Primer on Scientific Programming with Python `_
@@ -138,7 +138,7 @@ choosen from mathematics and the natural sciences.
Numerical Methods in Engineering with Python
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Numerical Methods in Engineering with Python,written by Jaan Kiusalaas, attempts to
+Numerical Methods in Engineering with Python,written by Jaan Kiusalaas, attempts to
emphasis on numerical methods and how to implement them in python.
`Numerical Methods in Engineering with Python `_
From 4cc1d119f14c207b17e2c2a157bda954a854fba9 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 11:56:16 -0700
Subject: [PATCH 010/992] Add link to 'Python in a Nutshell'.
---
docs/intro/learning.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst
index 27e770def..0cb397b2f 100644
--- a/docs/intro/learning.rst
+++ b/docs/intro/learning.rst
@@ -153,6 +153,8 @@ Python in a Nutshell, written by Alex Martelli, covers most cross-platform
python's usage, from its syntax to built-in libraries to advanced topics such
as writing C extensions.
+ `Python in a Nutshell `_
+
The Python Language Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
From 56924481c2006be27168546eded9748844d737aa Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 01:21:46 -0700
Subject: [PATCH 011/992] Update Buildbot URL.
---
docs/scenarios/ci.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index 3a80c70b3..d9fc431ab 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -26,7 +26,7 @@ engine. Use it.
Buildbot
--------
-`Buildbot `_ is a Python system to
+`Buildbot `_ is a Python system to
automate the compile/test cycle to validate code changes.
@@ -85,4 +85,4 @@ thorough.
In order to activate testing for your project, go to `the travis-ci site `_
and login with your Github account. Then activate your project in your profile settings and that's
-it. From now on, your project's tests will be run on every push to Github.
+it. From now on, your project's tests will be run on every push to Github.
From e094175bd6ae59f979845e0e85e14f81422ff015 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 01:22:47 -0700
Subject: [PATCH 012/992] Update tox URL.
---
docs/scenarios/ci.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index d9fc431ab..1bb2af534 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -38,7 +38,7 @@ Mule?
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:
From 8b9e3bb877411f86e56cb1d31fb0e05ef167053d Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 01:23:15 -0700
Subject: [PATCH 013/992] Update Travis CI URL because always https.
---
docs/scenarios/ci.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index 1bb2af534..6e2025d91 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -53,7 +53,7 @@ which provides the following features:
Travis-CI
---------
-`Travis-CI `_ is a distributed CI server which builds tests
+`Travis-CI `_ is a distributed CI server which builds tests
for open source projects for free. It provides multiple workers to run Python tests
on and seamlessly integrates with Github. You can even have it comment on your Pull
Requests whether this particular changeset breaks the build or not. So if you are
@@ -83,6 +83,6 @@ notifications, before and after steps and much more. The
`travis-ci docs `_ explain all of those and are very
thorough.
-In order to activate testing for your project, go to `the travis-ci site `_
+In order to activate testing for your project, go to `the travis-ci site `_
and login with your Github account. Then activate your project in your profile settings and that's
it. From now on, your project's tests will be run on every push to Github.
From edf7f04e491e7b4aa799e655ea0cf92369f501c8 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 01:26:15 -0700
Subject: [PATCH 014/992] Use Wayback Machine to resolve a dead link.
---
docs/scenarios/db.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/db.rst b/docs/scenarios/db.rst
index 5d12c2a51..6d6d6ce7a 100644
--- a/docs/scenarios/db.rst
+++ b/docs/scenarios/db.rst
@@ -11,7 +11,7 @@ Nearly all Python database modules such as `sqlite3`, `psycopg` and
Tutorials that explain how to work with modules that conform to this interface can be found
`here `__ and
-`here `__.
+`here `__.
SQLAlchemy
----------
From 709823707823db459e8c02d9343495eb4ecedd37 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 01:27:22 -0700
Subject: [PATCH 015/992] Add Qt link.
---
docs/scenarios/gui.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/gui.rst b/docs/scenarios/gui.rst
index 4dbc650b8..d85a83663 100644
--- a/docs/scenarios/gui.rst
+++ b/docs/scenarios/gui.rst
@@ -4,7 +4,7 @@ GUI Applications
Qt
--
-Qt is a cross-platform application framework that is widely used for developing
+`Qt `_ is a cross-platform application framework that is widely used for developing
software with a GUI but can also be used for non-GUI applications.
PySide
From 55fc9b08e41516eddb856c83ba441883f0a7781d Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 11:42:32 -0700
Subject: [PATCH 016/992] Update Gunicorn help link.
---
docs/scenarios/web.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst
index 3e40f16cb..d074752bb 100644
--- a/docs/scenarios/web.rst
+++ b/docs/scenarios/web.rst
@@ -152,7 +152,7 @@ lightweight, easy to use, and uses many UNIX idioms. Gunicorn is not designed
to face the internet -- it was designed to run behind Nginx which buffers
slow requests and takes care of other important considerations. A sample
setup for Nginx + Gunicorn can be found in the
-`Gunicorn help `_.
+`Gunicorn help `_.
.. _uwsgi-ref:
From 788390e74f1fbd3c4457d8b981134ed9e2a5d501 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 11:44:32 -0700
Subject: [PATCH 017/992] Update link to Gondor documentation.
---
docs/scenarios/web.rst | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst
index d074752bb..4574096e7 100644
--- a/docs/scenarios/web.rst
+++ b/docs/scenarios/web.rst
@@ -235,9 +235,7 @@ and Pinax applications. Gondor supports Django versions 1.2 and 1.3 on
Python version 2.7, and can automatically configure your Django site if you
use ``local_settings.py`` for site-specific configuration information.
-Gondor publishes guides to deploying `Django projects
-`_ and `Pinax projects
-`_ on their platform.
+Gondor has a guide on deploying `Django projects `_.
Templating
From cf93e79274c467d7ea82fa2b31c0561fffe54e4a Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 11:49:59 -0700
Subject: [PATCH 018/992] Update virtualenvwrapper documentation links.
---
docs/dev/virtualenvs.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index ee6ace244..c08f1118e 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -60,7 +60,7 @@ where they were placed.
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.
@@ -72,7 +72,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-powershell `_ clone.
@@ -136,7 +136,7 @@ Other useful commands
``lssitepackages``
Shows contents of ``site-packages`` directory.
-`Full list of virtualenvwrapper commands `_.
+`Full list of virtualenvwrapper commands `_.
autoenv
-------
From f51141c973d2fcd6abd5d45be503917756de96e4 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 11:54:40 -0700
Subject: [PATCH 019/992] Update link to 'A Byte of Python'.
---
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 852e786cb..e5d074259 100644
--- a/docs/intro/learning.rst
+++ b/docs/intro/learning.rst
@@ -92,7 +92,7 @@ A free introductory book that teaches python at the beginner level, it assumes n
previous programming experience.
`A Byte of Python for Python 2.x `_
- `A Byte of Python for Python 3.x `_
+ `A Byte of Python for Python 3.x `_
Advanced
From 2cd385e61c758661cf43518b5080dcdc7267cf1e Mon Sep 17 00:00:00 2001
From: kuyan
Date: Sat, 24 Aug 2013 11:56:16 -0700
Subject: [PATCH 020/992] Add link to 'Python in a Nutshell'.
---
docs/intro/learning.rst | 1 -
1 file changed, 1 deletion(-)
diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst
index e5d074259..b8e31c499 100644
--- a/docs/intro/learning.rst
+++ b/docs/intro/learning.rst
@@ -162,7 +162,6 @@ as writing C extensions.
`Python in a Nutshell `_
-
The Python Language Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
From 239909dc4c2f6fa273f7c0ec27f33b4d6d2391ac Mon Sep 17 00:00:00 2001
From: Alois Mahdal
Date: Tue, 24 Sep 2013 14:01:59 +0200
Subject: [PATCH 021/992] Clarify presence of a two-element tuple.
---
docs/writing/style.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/docs/writing/style.rst b/docs/writing/style.rst
index e48956a2e..a631e4a0c 100644
--- a/docs/writing/style.rst
+++ b/docs/writing/style.rst
@@ -273,7 +273,8 @@ Unpacking
~~~~~~~~~
If you know the length of a list or tuple, you can assign names to its
-elements with unpacking:
+elements with unpacking. For example, since you know that ``enumerate()``
+will provide a tuple of two elements for each item in list:
.. code-block:: python
From f32ef5f38f4b4db300b334b1ee4b98950826199d Mon Sep 17 00:00:00 2001
From: Alois Mahdal
Date: Tue, 24 Sep 2013 22:25:57 +0200
Subject: [PATCH 022/992] Reworded per rgbkrk's suggestion
---
docs/writing/style.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/writing/style.rst b/docs/writing/style.rst
index a631e4a0c..33339ff9f 100644
--- a/docs/writing/style.rst
+++ b/docs/writing/style.rst
@@ -273,8 +273,8 @@ Unpacking
~~~~~~~~~
If you know the length of a list or tuple, you can assign names to its
-elements with unpacking. For example, since you know that ``enumerate()``
-will provide a tuple of two elements for each item in list:
+elements with unpacking. For example, since ``enumerate()`` will provide
+a tuple of two elements for each item in list:
.. code-block:: python
From 4e1b3771e5a12eeb4c250db28357d016121e9204 Mon Sep 17 00:00:00 2001
From: kuyan
Date: Mon, 14 Oct 2013 15:20:29 -0700
Subject: [PATCH 023/992] Link to `fpm` (see #328)
---
docs/shipping/packaging.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst
index e91bb33d6..466665af9 100644
--- a/docs/shipping/packaging.rst
+++ b/docs/shipping/packaging.rst
@@ -78,5 +78,5 @@ For Linux Distributions
Useful Tools
------------
-- epm
+- `fpm `_
- alien
From 525c834d596d3ff014b4c71d2c73a32743ee2956 Mon Sep 17 00:00:00 2001
From: Kenneth Reitz
Date: Thu, 24 Oct 2013 18:16:48 -0400
Subject: [PATCH 024/992] Get Updates
---
docs/_templates/sidebarintro.html | 5 +++++
docs/_templates/sidebarlogo.html | 5 +++++
2 files changed, 10 insertions(+)
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index b9901b381..58c71b058 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -3,6 +3,11 @@ Python Guide.
This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis.
+Get Updates
+Receive updates on new releases and upcoming projects.
+
+Subscribe to Newsletter
+
Donate
If you enjoy this guide, consider supporting the author on Gittip:
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
index d7f12de20..5a40255d5 100644
--- a/docs/_templates/sidebarlogo.html
+++ b/docs/_templates/sidebarlogo.html
@@ -3,6 +3,11 @@
This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis.
+Get Updates
+Receive updates on new releases and upcoming projects.
+
+Subscribe to Newsletter
+
Donate
If you enjoy this guide, consider supporting the author on Gittip:
From eb950d52c96a4a0a468e5db3b143a0644646e70f Mon Sep 17 00:00:00 2001
From: Jens Rantil
Date: Mon, 28 Oct 2013 23:15:38 +0100
Subject: [PATCH 025/992] Link to `alien`
This fully fixes #328.
---
docs/shipping/packaging.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst
index 466665af9..ef7df6782 100644
--- a/docs/shipping/packaging.rst
+++ b/docs/shipping/packaging.rst
@@ -79,4 +79,4 @@ Useful Tools
------------
- `fpm `_
-- alien
+- `alien `_
From 00619354b8f742d2e9c0b86f92640a571a260069 Mon Sep 17 00:00:00 2001
From: Pengkui Luo
Date: Sat, 2 Nov 2013 05:56:54 -0500
Subject: [PATCH 026/992] PyPy recently released beta support to Python 3.
---
docs/starting/which-python.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index 2fc852541..0413a897f 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -51,7 +51,7 @@ that rely on C extensions for their functionality (e.g. numpy) then CPython
is your only choice.
Being the reference implementation, all versions of the Python language are
-available as CPython. Python 3 is only available as a CPython implementation.
+available as CPython.
PyPy
----
@@ -67,7 +67,8 @@ If you are looking to squeeze more performance out of your Python code, it's
worth giving PyPy a try. On a suite of benchmarks, it's currently `over 5 times
faster than CPython `_.
-Currently PyPy supports Python 2.7. [#pypy_ver]_
+Currently PyPy supports Python 2.7. PyPy3 which targets Python 3 was recently
+available as a beta release. [#pypy_ver]_
Jython
------
From 12fe8d779bbec515aeb359a4e3e3be329fe433fe Mon Sep 17 00:00:00 2001
From: Pengkui Luo
Date: Sat, 2 Nov 2013 06:19:19 -0500
Subject: [PATCH 027/992] python-2.7.5 is available.
---
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 bdfa3f08a..a05893b69 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 then use the "Windows Installer" link from the home page of the
`Python.org web site `_ .
From 83630edf35b468dbf96815f02fd25db70141204f Mon Sep 17 00:00:00 2001
From: Pengkui Luo
Date: Sat, 2 Nov 2013 06:19:56 -0500
Subject: [PATCH 028/992] typos
---
docs/starting/install/win.rst | 2 +-
docs/starting/which-python.rst | 4 ++--
docs/writing/structure.rst | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/starting/install/win.rst b/docs/starting/install/win.rst
index a05893b69..f1d9386e5 100644
--- a/docs/starting/install/win.rst
+++ b/docs/starting/install/win.rst
@@ -80,7 +80,7 @@ project. This is particularly important for Web development, where each
framework and application will have many dependencies.
-To set up a new Python environment, change the working directory to where ever
+To set up a new Python environment, change the working directory to wherever
you want to store the environment, and run the virtualenv utility in your
project's directory
diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst
index 0413a897f..cc79c362f 100644
--- a/docs/starting/which-python.rst
+++ b/docs/starting/which-python.rst
@@ -47,7 +47,7 @@ level of compatibility with Python packages and C extension modules.
If you are writing open-source Python code and want to reach the widest possible
audience, targeting CPython is your best bet. If you need to use any packages
-that rely on C extensions for their functionality (e.g. numpy) then CPython
+that rely on C extensions for their functionality (e.g., numpy) then CPython
is your only choice.
Being the reference implementation, all versions of the Python language are
@@ -74,7 +74,7 @@ Jython
------
`Jython `_ is a Python implementation that compiles
-Python code to Java byte code that is then executed in a JVM. It has the additional
+Python code to Java bytecode that is then executed in a JVM. It has the additional
advantage of being able to import and use any Java class like a Python
module.
diff --git a/docs/writing/structure.rst b/docs/writing/structure.rst
index 9bb685c6b..0529b21ec 100644
--- a/docs/writing/structure.rst
+++ b/docs/writing/structure.rst
@@ -14,7 +14,7 @@ isolated? By answering questions like these you can begin to plan, in
a broad sense, what your finished product will look like.
In this section we take a closer look at Python's module and import
-systems as they are the central element to enforcing structure in your
+systems as they are the central elements to enforcing structure in your
project. We then discuss various perspectives on how to build code which
can be extended and tested reliably.
From b3c7bd1ae2dd6f2879426e9fbc1a219d5caf34ea Mon Sep 17 00:00:00 2001
From: Paul Hallett
Date: Wed, 6 Nov 2013 12:03:52 +0000
Subject: [PATCH 029/992] Added link to the python packaging guide.
---
docs/shipping/packaging.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst
index e91bb33d6..7dd275319 100644
--- a/docs/shipping/packaging.rst
+++ b/docs/shipping/packaging.rst
@@ -5,6 +5,8 @@ Packaging your code is important.
You'll need to package your code first before sharing it with other developers.
+The `Python Packaging Guide `_ provides an extensive guide on creating and maintaining Python packages.
+
For Python Developers
:::::::::::::::::::::
From d17acbf5151c923a3588c8dd8697041fc21cf9dd Mon Sep 17 00:00:00 2001
From: Can Ibanoglu
Date: Fri, 8 Nov 2013 21:21:56 +0200
Subject: [PATCH 030/992] Added virtual environment enforcing for pip for the
osx installation tutorial
---
docs/starting/install/osx.rst | 43 +++++++++++++++++++++++++++++++++++
1 file changed, 43 insertions(+)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index dc6676733..b84eeb02f 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -119,6 +119,49 @@ An useful set of extensions to virtualenv is available in virtualenvwrapper,
`RTFD `_ to find out more.
+A note about Pip and Virtualenv
+-------------------------------
+
+By now it should be clear that using virtual environments is a great way to keep
+your development environment clean and keeping different projects' requirements
+separate.
+
+When you start working on many different projects, it can be hard to remember to
+activate the related virtual environment when you come back to a specific project.
+As a result of this, it is very easy to install packages globally while thinking
+that you are actually installing the package for the virtual 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
+``~/.bashrc`` file:
+
+.. code-block:: console
+ export PIP_REQUIRE_VIRTUALENV=true
+
+After saving this change and sourcing the ``~/.bashrc`` file with ``source ~/.bashrc``,
+pip will no longer let you install packages if you are not in a virtual environment.
+If you try to use ``pip install`` outside of a virtual environment pip will
+gently remind you that an activated virtual environment is needed to install
+packages.
+
+.. code-block:: console
+ $ pip install requests
+ Could not find an activated virtualenv (required).
+
+You will of course need to install some packages globally and this can be accomplished
+by adding the following to your ``~/.bashrc`` file:
+
+.. code-block:: console
+ gpip() {
+ PIP_REQUIRE_VIRTUALENV="" pip "$@"
+ }
+
+After saving the changes and sourcing your ``~/.bashrc`` file you can now install
+packages globally by running ``gpip install``. You can change the name of the
+function to anything you like, just keep in mind that you will have to use that
+name when trying install packages globally with pip.
+
--------------------------------
This page is a remixed version of `another guide `_,
From 387170572a07af5847c09165f09f1ca281a663c5 Mon Sep 17 00:00:00 2001
From: Mher Movsisyan
Date: Sat, 9 Nov 2013 18:02:41 +0300
Subject: [PATCH 031/992] The latest OSX version is Mavericks
---
docs/starting/install/osx.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index dc6676733..fa41f8c9f 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -3,7 +3,7 @@
Installing Python on Mac OS X
=============================
-The latest version of Mac OS X, Mountain Lion, **comes with Python 2.7 out of the box**.
+The latest version of Mac OS X, Mavericks, **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
From 3f7fb5e75648b059b1fceb5e379aa12c73285eca Mon Sep 17 00:00:00 2001
From: ugurthemaster
Date: Mon, 18 Nov 2013 11:16:29 +0200
Subject: [PATCH 032/992] Update learning.rst
"Python Pocket Reference" has been added.
---
docs/intro/learning.rst | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst
index b8e31c499..c3c0a2278 100644
--- a/docs/intro/learning.rst
+++ b/docs/intro/learning.rst
@@ -169,3 +169,12 @@ This is Python's reference manual, it covers the syntax and the core semantics o
language.
`The Python Language Reference `_
+
+Python Pocket Reference
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Python Pocket Reference, written by Mark Lutz, is an easy to use reference to the
+core language, with descriptions of commonly used modules and toolkits. It covers
+Python 3 and 2.6 versions.
+
+ `Python Pocket Reference `_
From 203b92ce617411ed65f9ad4a7c475c14690b83e0 Mon Sep 17 00:00:00 2001
From: ugurthemaster
Date: Mon, 25 Nov 2013 11:05:54 +0200
Subject: [PATCH 033/992] Update documentation.rst
---
docs/writing/documentation.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst
index d543f53f5..7793af4bb 100644
--- a/docs/writing/documentation.rst
+++ b/docs/writing/documentation.rst
@@ -94,7 +94,9 @@ Reference`_ should help you familiarize yourself with its syntax.
Code Documentation Advice
-------------------------
-Comments clarify code and begin with a hash (``#``).
+Comments clarify the code and they are added with purpose of making the
+code easier to understand. In Python, comments begin with a hash
+(number sign) (``#``).
.. _docstring-ref:
From 83a99468b7ce9c4fd3126984b0df6a2c3db2adbd Mon Sep 17 00:00:00 2001
From: Pengkui Luo
Date: Tue, 26 Nov 2013 01:21:26 -0600
Subject: [PATCH 034/992] python-2.7.6
---
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 f1d9386e5..b71b882ea 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 then use the "Windows Installer" link from the home page of the
`Python.org web site `_ .
From bd7147401280c4d079c6b50162d4d5f7f130edf1 Mon Sep 17 00:00:00 2001
From: ugurthemaster
Date: Tue, 26 Nov 2013 09:30:18 +0200
Subject: [PATCH 035/992] Update cli.rst
Information about Clint has been added.
---
docs/scenarios/cli.rst | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst
index 546eae017..933b0f082 100644
--- a/docs/scenarios/cli.rst
+++ b/docs/scenarios/cli.rst
@@ -6,11 +6,14 @@ Command Line Applications
Clint
-----
-.. todo:: Write about Clint
+`clint `_ is a python module which is
+filled with very useful tools for developing commandline applications.
+It supports features such as; CLI Colors and Indents, Simple and Powerful
+Column Printer, Iterator based progress bar and Implicit argument handling.
docopt
------
`docopt `_ is a lightweight, highly Pythonic package that
allows creating command line interfaces easily and intuitively, by parsing
-POSIX-style usage instructions.
\ No newline at end of file
+POSIX-style usage instructions.
From 78016d6cf9b3fdf187719840e2a93392f41be5f4 Mon Sep 17 00:00:00 2001
From: Matt Hughes
Date: Mon, 2 Dec 2013 10:50:53 -0500
Subject: [PATCH 036/992] Added instructions for s3-hosted PyPi repo
Adapted from an awesome article by @jsutlovic
---
docs/shipping/packaging.rst | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst
index e91bb33d6..7ffc5bac9 100644
--- a/docs/shipping/packaging.rst
+++ b/docs/shipping/packaging.rst
@@ -67,6 +67,36 @@ Chishop
written in django which allows you to register/upload with distutils and
install with easy_install/pip.
+S3-Hosted PyPi
+++++++++++++++
+
+One simple option for a personal PyPi server is to use Amazon S3. A prerequisite for this is that you have an Amazon AWS account with an S3 bucket.
+
+1. **Install all your requirements from PyPi or another source**
+2. **Install pip2pi**
+
+* :code:`pip install git+https://github.com/wolever/pip2pi.git`
+
+3. **Follow pip2pi README for pip2tgz and dir2pi commands**
+
+* :code:`pip2tgz packages/ YourPackage` (or :code:`pip2tgz packages/ -r requirements.txt`)
+* :code:`dir2pi packages/`
+
+4. **Upload the new files**
+
+* Use a client like Cyberduck to sync the entire :code:`packages` folder to your s3 bucket
+* Make sure you upload :code:`packages/simple/index.html` as well as all new files and directories
+
+5. **Fix new file permissions**
+
+* By default, when you upload new files to the S3 bucket, they will have the wrong permissions set.
+* Use the Amazon web console to set the READ permission of the files to EVERYONE.
+* If you get HTTP 403 when trying to install a package, make sure you've set the permissions correctly.
+
+6. **All done**
+
+* You can now your package with :code:`pip install --index-url=http://your-s3-bucket/packages/simple/ YourPackage`
+
For Linux Distributions
::::::::::::::::::::::::
From 6dfc9ae9530ccebdecd361d7d66a40ca2f8bb5c3 Mon Sep 17 00:00:00 2001
From: Natan L
Date: Mon, 2 Dec 2013 22:58:17 -0800
Subject: [PATCH 037/992] Fix broken link
---
docs/writing/style.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/writing/style.rst b/docs/writing/style.rst
index 33339ff9f..262d73471 100644
--- a/docs/writing/style.rst
+++ b/docs/writing/style.rst
@@ -434,7 +434,7 @@ Check if variable equals a constant
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You don't need to explicitly compare a value to True, or None, or 0 - you can
-just add it to the if statement. See :ref:`Truth Value Testing
+just add it to the if statement. See `Truth Value Testing
`_ for a
list of what is considered false.
From f0d1b23750a8260e1fc68cacad516b9275e551eb Mon Sep 17 00:00:00 2001
From: Han Su Kim
Date: Thu, 5 Dec 2013 15:16:11 -0500
Subject: [PATCH 038/992] Added Ansible to the list
Ansible is a tool written in Python for IT automation and orchestration.
---
docs/scenarios/admin.rst | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst
index 4bdfe6802..7f20dcd39 100644
--- a/docs/scenarios/admin.rst
+++ b/docs/scenarios/admin.rst
@@ -176,6 +176,15 @@ Here is an example to be aware of some server overload. In case of some failed t
A full terminal application like a widely extended top which is based on psutil and with the ability of a client-server
monitoring is `glance `_.
+Ansible
+Chef
+----
+
+.. todo:: Write about Ansible
+
+ `Ansible Documentation
+ `_
+
Chef
----
From 26f94e45db5354a809397963490efaa9be946cc9 Mon Sep 17 00:00:00 2001
From: justinhorner
Date: Thu, 2 Jan 2014 18:00:43 -0700
Subject: [PATCH 039/992] Update env.rst
trailing slash in link caused 404, removed to fix link
---
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 81da462b0..7097ee51c 100644
--- a/docs/dev/env.rst
+++ b/docs/dev/env.rst
@@ -130,7 +130,7 @@ PyCharm / IntelliJ IDEA
`PyCharm `_ is developed by JetBrains, also
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 `_.
+features can be brought to IntelliJ with the free `Python Plug-In `_.
Eclipse
From 919884c45ccf8b9f10f011826a82d1e39a6e8d88 Mon Sep 17 00:00:00 2001
From: Lyndsy Simon
Date: Tue, 14 Jan 2014 14:41:14 -0500
Subject: [PATCH 040/992] Adds recommendation to add /usr/local/sbin to
/usr/local/bin:/usr/local/sbin:/usr/local/bin:/Users/lyndsy/.bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/usr/local/MacGPG2/bin
in OSX
---
docs/starting/install/osx.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst
index fa41f8c9f..8017bfb3b 100644
--- a/docs/starting/install/osx.rst
+++ b/docs/starting/install/osx.rst
@@ -50,7 +50,7 @@ line at the bottom of your ``~/.bashrc`` file
.. code-block:: console
- export PATH=/usr/local/bin:$PATH
+ export PATH=/usr/local/bin:/usr/local/sbin:$PATH
Now, we can install Python 2.7: ::
From 5156f9011ab775bd9e34ae45fb108f7cbe16329d Mon Sep 17 00:00:00 2001
From: Jonathan Steinmann
Date: Thu, 16 Jan 2014 23:04:10 -0500
Subject: [PATCH 041/992] update db.rst
expand on Django ORM basics
---
docs/scenarios/db.rst | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/docs/scenarios/db.rst b/docs/scenarios/db.rst
index 6d6d6ce7a..787f0efe3 100644
--- a/docs/scenarios/db.rst
+++ b/docs/scenarios/db.rst
@@ -33,3 +33,11 @@ to provide database access.
It's based on the idea of `models `_, an abstraction that makes it easier to
manipulate data in Python.
+The basics:
+
+- Each model is a Python class that subclasses django.db.models.Model.
+- Each attribute of the model represents a database field.
+- Django gives you an automatically-generated database-access API; see `Making queries `__.
+to provide database access.
+
+
From db5bcf53749a9617c6c33c105d88c05bf9c540ab Mon Sep 17 00:00:00 2001
From: Jeff Paine
Date: Sat, 18 Jan 2014 08:33:56 -0500
Subject: [PATCH 042/992] Remove python 2.5 from example travis config
Travis does not support python <2.6
---
docs/scenarios/ci.rst | 1 -
1 file changed, 1 deletion(-)
diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index 6e2025d91..3d67f78e9 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -65,7 +65,6 @@ example content::
language: python
python:
- - "2.5"
- "2.6"
- "2.7"
- "3.1"
From ed74bde2337388f5ba8545bd2f59f43f409e2ce4 Mon Sep 17 00:00:00 2001
From: Jeff Paine
Date: Sat, 18 Jan 2014 15:48:35 -0500
Subject: [PATCH 043/992] Remove python 3.1, add python 3.3
---
docs/scenarios/ci.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index 3d67f78e9..e5dd565d5 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -67,8 +67,8 @@ example content::
python:
- "2.6"
- "2.7"
- - "3.1"
- "3.2"
+ - "3.3"
# command to install dependencies
script: python tests/test_all_of_the_units.py
branches:
From 494e80504da660eeecb64b8e338f2503e9e3781c Mon Sep 17 00:00:00 2001
From: smithandrewl
Date: Sat, 18 Jan 2014 21:27:08 -0600
Subject: [PATCH 044/992] Updated capitalization in admin.rst
Updated capitalization of fabric and salt to Fabric and Salt
---
docs/scenarios/admin.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst
index 7f20dcd39..84c98da13 100644
--- a/docs/scenarios/admin.rst
+++ b/docs/scenarios/admin.rst
@@ -6,7 +6,7 @@ Fabric
`Fabric `_ is a library for simplifying system
administration tasks. While Chef and Puppet tend to focus on managing servers
-and system libraries, fabric is more focused on application level tasks such
+and system libraries, Fabric is more focused on application level tasks such
as deployment.
Install Fabric:
@@ -77,7 +77,7 @@ It supports remote command execution from a central point (master host) to multi
hosts (minions). It also supports system states which can be used to configure
multiple servers using simple template files.
-Salt supports python versions 2.6 and 2.7 and can be installed via pip:
+Salt supports Python versions 2.6 and 2.7 and can be installed via pip:
.. code-block:: console
@@ -95,7 +95,7 @@ The following command lists all available minion hosts, using the ping module.
The host filtering is accomplished by matching the minion id, or using the grains system.
The `grains `_ system
uses static host information like the operating system version or the CPU architecture to
-provide a host taxonomy for the salt modules.
+provide a host taxonomy for the Salt modules.
The following command lists all available minions running CentOS using the grains system:
@@ -119,7 +119,7 @@ and start the Apache server:
- require:
- pkg: apache
-State files can be written using YAML, the Jinja2 template system or pure python.
+State files can be written using YAML, the Jinja2 template system or pure Python.
`Salt Documentation `_
From afa61148f0215f445a831b6a8ade1dfc84d015dd Mon Sep 17 00:00:00 2001
From: smithandrewl
Date: Sat, 18 Jan 2014 21:31:10 -0600
Subject: [PATCH 045/992] Hyphenation in ci.rst
Replaced frontend with front-end
---
docs/scenarios/ci.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index 6e2025d91..5a36bfb1d 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -47,7 +47,7 @@ which provides the following features:
interpreters
* Running tests in each of the environments, configuring your test tool of
choice
-* Acting as a frontend to Continuous Integration servers, reducing boilerplate
+* Acting as a front-end to Continuous Integration servers, reducing boilerplate
and merging CI and shell-based testing.
From 3918f6b62aec0c75772246baa419056b8961dcfa Mon Sep 17 00:00:00 2001
From: smithandrewl
Date: Sat, 18 Jan 2014 21:41:34 -0600
Subject: [PATCH 046/992] Spelling and capitalization in scientific.rst
Changed python to Python and corrected some spelling
---
docs/scenarios/scientific.rst | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/docs/scenarios/scientific.rst b/docs/scenarios/scientific.rst
index a95f9867f..0d45807fa 100644
--- a/docs/scenarios/scientific.rst
+++ b/docs/scenarios/scientific.rst
@@ -9,7 +9,7 @@ Python is frequently used for high-performance scientific applications. Python
is widely used in academia and scientific projects because it is easy to write,
and it performs really well.
-Due to its high performance nature, scientific computing in python often refers
+Due to its high performance nature, scientific computing in Python often refers
to external libraries, typically written in faster languages (like C, or
FORTRAN for matrix operations). The main libraries used are `NumPy`_, `SciPy`_
and `Matplotlib`_. Going into detail about these libraries is beyond the scope
@@ -24,11 +24,11 @@ Tools
IPython
-------
-`IPytthon `_ is an enhanced version of Python interpreter.
+`IPython `_ is an enhanced version of Python interpreter.
The features it provides are of great interest for the scientists. The `inline mode`
allow graphics and plots to be displayed in the terminal (Qt based version).
Moreover the `notebook` mode supports literate programming and reproducible science
-generating a web-based python notebook. This notebook allowing to store chunk of
+generating a web-based Python notebook. This notebook allowing to store chunk of
Python code along side to the results and additional comments (HTML, LaTeX, Markdown).
The notebook could be shared and exported in various file formats.
@@ -64,7 +64,7 @@ SciPy
`SciPy `_ is a library that uses Numpy for more mathematical
functions. SciPy uses NumPy arrays as the basic data structure. SciPy comes
-with modules for various commonly used tasks in scientific programing, for
+with modules for various commonly used tasks in scientific programming, for
example: linear algebra, integration (calculus), ordinary differential equation
solvers and signal processing.
@@ -86,7 +86,7 @@ based on Numpy and which provides many useful functions for accessing,
indexing, merging and grouping data easily. The main data structure (DataFrame)
is close to what could be found in the R statistical package, that is
an heterogeneous data tables with name indexing, time series operations
-and auto-alignement of data.
+and auto-alignment of data.
Rpy2
----
@@ -120,7 +120,7 @@ Many people who do scientific computing are on Windows. And yet many of the
scientific computing packages are notoriously difficult to build and install.
`Christoph Gohlke `_ however, has
compiled a list of Windows binaries for many useful Python packages. The list
-of packages has grown from a mainly scientific python resource to a more
+of packages has grown from a mainly scientific Python resource to a more
general list. It might be a good idea to check it out if you're on Windows.
Enthought Python Distribution (EPD)
From 1f61583f10c421720ce14195b5f433fbcd069f3f Mon Sep 17 00:00:00 2001
From: smithandrewl
Date: Sat, 18 Jan 2014 21:47:45 -0600
Subject: [PATCH 047/992] Capitalization in xml.rst
replaced:
* xml to XML
* python to Python
* json to JSON
---
docs/scenarios/xml.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/scenarios/xml.rst b/docs/scenarios/xml.rst
index 1f8db9c4c..ee97e2d02 100644
--- a/docs/scenarios/xml.rst
+++ b/docs/scenarios/xml.rst
@@ -8,7 +8,7 @@ untangle
an XML document and returns a Python object which mirrors the nodes and
attributes in its structure.
-For example, an xml file like this:
+For example, an XML file like this:
.. code-block:: xml
@@ -36,9 +36,9 @@ xmltodict
---------
`xmltodict `_ is another simple
-library that aims at making xml feel like working with json.
+library that aims at making XML feel like working with JSON.
-An xml file like this:
+An XML file like this:
.. code-block:: xml
@@ -52,7 +52,7 @@ An xml file like this:
-can be loaded into a python dict like this:
+can be loaded into a Python dict like this:
.. code-block:: python
@@ -68,6 +68,6 @@ and then you can access elements, attributes and values like this:
doc['mydocument']['plus']['@a'] # == u'complex'
doc['mydocument']['plus']['#text'] # == u'element as well'
-xmltodict also lets you roundtrip back to xml with the unparse function,
+xmltodict also lets you roundtrip back to XML with the unparse function,
has a streaming mode suitable for handling files that don't fit in memory
and supports namespaces.
From 065f69d219d3b34e3d2e6648dc54f27ee99e6bee Mon Sep 17 00:00:00 2001
From: smithandrewl
Date: Sat, 18 Jan 2014 21:51:42 -0600
Subject: [PATCH 048/992] Capitalization in packaging.rst
Replaced python with Python
---
docs/shipping/packaging.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst
index 100ae9116..54d72b04a 100644
--- a/docs/shipping/packaging.rst
+++ b/docs/shipping/packaging.rst
@@ -46,7 +46,7 @@ Go to your command prompt and type:
$ python -m SimpleHTTPServer 9000
This runs a simple http server running on port 9000 and will list all packages
-(like **MyPackage**). Now you can install **MyPackage** using any python
+(like **MyPackage**). Now you can install **MyPackage** using any Python
package installer. Using Pip, you would do it like:
.. code-block:: console
From 5444d703d5253688e93f3f54fdfbd72fa7106d0b Mon Sep 17 00:00:00 2001
From: smithandrewl
Date: Sat, 18 Jan 2014 21:58:43 -0600
Subject: [PATCH 049/992] Capitalization in env.rst
Replaced python with Python
---
docs/dev/env.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/dev/env.rst b/docs/dev/env.rst
index 7097ee51c..e2e628cb7 100644
--- a/docs/dev/env.rst
+++ b/docs/dev/env.rst
@@ -64,7 +64,7 @@ to do that which also shows status and warning messages in the statusbar would b
Python-mode
^^^^^^^^^^^
-Python-mode_ is a complex solution in VIM for working with python code.
+Python-mode_ is a complex solution in VIM for working with Python code.
It has:
- Asynchronous Python code checking (pylint, pyflakes, pep8, mccabe) in any combination
@@ -94,7 +94,7 @@ Emacs is a powerful text editor. It's fully programmable (lisp), but
it can be some work to wire up correctly. A good start if you're
already an Emacs user is `Python Programming in Emacs`_ at EmacsWiki.
-1. Emacs itself comes with a python mode.
+1. Emacs itself comes with a Python mode.
2. Python ships with an alternate version:
`python-mode.el `_
3. Fabián Ezequiel Gallina's `python.el `_
From f828b185d9cd4079e9297d3ca193f998a8a8918f Mon Sep 17 00:00:00 2001
From: smithandrewl
Date: Sat, 18 Jan 2014 22:12:07 -0600
Subject: [PATCH 050/992] Update learning.rst
Changed choosen to chosen
Replaced python with Python
---
docs/intro/learning.rst | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst
index c3c0a2278..b7633f9cf 100644
--- a/docs/intro/learning.rst
+++ b/docs/intro/learning.rst
@@ -7,9 +7,9 @@ Beginner
Learn Python Interactive Tutorial
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Learnpython.org is an easy non-intimidating way to get introduced to python.
+Learnpython.org is an easy non-intimidating way to get introduced to Python.
The website takes the same approach used on the popular `Try Ruby `_
-website, it has an interactive python interpreter built into the site that
+website, it has an interactive Python interpreter built into the site that
allows you to go through the lessons without having to install Python locally.
`Learn Python `_
@@ -52,11 +52,11 @@ Think Python: How to Think Like a Computer Scientist
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Think Python attempts to give an introduction to basic concepts in computer
-science through the use of the python language. The focus was to create a book
+science through the use of the Python language. The focus was to create a book
with plenty of exercises, minimal jargon and a section in each chapter devoted
to the subject of debugging.
-While exploring the various features available in the python language the
+While exploring the various features available in the Python language the
author weaves in various design patterns and best practices.
The book also includes several case studies which have the reader explore the
@@ -72,11 +72,11 @@ Python Koans
Python Koans is a port of Edgecase's Ruby Koans. It uses a test-driven
approach, q.v. TEST DRIVEN DESIGN SECTION to provide an interactive tutorial
-teaching basic python concepts. By fixing assertion statements that fail in a
-test script, this provides sequential steps to learning python.
+teaching basic Python concepts. By fixing assertion statements that fail in a
+test script, this provides sequential steps to learning Python.
For those used to languages and figuring out puzzles on their own, this can be
-a fun, attractive option. For those new to python and programming, having an
+a fun, attractive option. For those new to Python and programming, having an
additional resource or reference will be helpful.
`Python Koans `_
@@ -88,7 +88,7 @@ More information about test driven development can be found at these resources:
A Byte of Python
~~~~~~~~~~~~~~~~
-A free introductory book that teaches python at the beginner level, it assumes no
+A free introductory book that teaches Python at the beginner level, it assumes no
previous programming experience.
`A Byte of Python for Python 2.x `_
@@ -137,8 +137,8 @@ A Primer on Scientific Programming with Python
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A Primer on Scientific Programming with Python, written by Hans Petter Langtangen,
-mainly covers python's usage in scientific field. In the book, examples are
-choosen from mathematics and the natural sciences.
+mainly covers Python's usage in scientific field. In the book, examples are
+chosen from mathematics and the natural sciences.
`A Primer on Scientific Programming with Python `_
@@ -146,7 +146,7 @@ Numerical Methods in Engineering with Python
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Numerical Methods in Engineering with Python,written by Jaan Kiusalaas, attempts to
-emphasis on numerical methods and how to implement them in python.
+emphasis on numerical methods and how to implement them in Python.
`Numerical Methods in Engineering with Python `_
@@ -157,7 +157,7 @@ Python in a Nutshell
~~~~~~~~~~~~~~~~~~~~
Python in a Nutshell, written by Alex Martelli, covers most cross-platform
-python's usage, from its syntax to built-in libraries to advanced topics such
+Python's usage, from its syntax to built-in libraries to advanced topics such
as writing C extensions.
`Python in a Nutshell `_
From 74b6d1d61273748e2c8e49f57b86b0099fd0e97d Mon Sep 17 00:00:00 2001
From: smithandrewl
Date: Sat, 18 Jan 2014 22:15:30 -0600
Subject: [PATCH 051/992] Replaced "python" with "Python"
---
docs/intro/news.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/intro/news.rst b/docs/intro/news.rst
index ec829f49a..433f9078d 100644
--- a/docs/intro/news.rst
+++ b/docs/intro/news.rst
@@ -19,7 +19,7 @@ Python-related news.
Pycoder's Weekly
~~~~~~~~~~~~~~~~
-Pycoder's Weekly is a free weekly python newsletter for Python developers
+Pycoder's Weekly is a free weekly Python newsletter for Python developers
by Python developers (Project, Articles, News, and Jobs).
`Pycoder's Weekly `_
From cdd31908faf4ea8383339ec66cb638c8a370afe2 Mon Sep 17 00:00:00 2001
From: smithandrewl
Date: Sat, 18 Jan 2014 22:27:06 -0600
Subject: [PATCH 052/992] Capitalization changes in web.rst
Replaced:
* python with Python
* javascript with JavaScript
---
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 4574096e7..d2178f10e 100644
--- a/docs/scenarios/web.rst
+++ b/docs/scenarios/web.rst
@@ -271,10 +271,10 @@ and to the templates themselves.
templates. This convenience can lead to uncontrolled
increase in complexity, and often harder to find bugs.
-- It is often necessary to mix javascript templates with
+- It is often necessary to mix JavaScript templates with
HTML templates. A sane approach to this design is to isolate
the parts where the HTML template passes some variable content
- to the javascript code.
+ to the JavaScript code.
@@ -370,7 +370,7 @@ The `base.html` file can be used as base for all site pages which are for exampl