- 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.
+
- If you enjoy this guide, consider supporting the author on Gittip:
-
+
+
+
+
+
+
+
-
+ 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.
-
Feedback
+
+
+
+
+
+
O'Reilly Book
+
+
This guide is now available in tangible book form!
+
+
+
+
All proceeds are being directly donated to the DjangoGirls organization.
+
+
Contributors
- Feedback is greatly appreciated. If you have any questions, comments,
- random praise, or anonymous threats,
- shoot me an email.
+ This guide is the result of the collaboration of
+ hundreds of people
+ around the world, and your contributions
+ are welcome!
- 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.
+
- If you enjoy this guide, consider supporting the author on Gittip:
+ 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.
-
-
-
\ No newline at end of file
+
+
+
+
+
+
+
O'Reilly Book
+
+
This guide is now available in tangible book form!
+
+
+
+
All proceeds are being directly donated to the DjangoGirls organization.
diff --git a/docs/_themes/README.rst b/docs/_themes/README.rst
deleted file mode 100644
index 2e875d46e..000000000
--- a/docs/_themes/README.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-krTheme Sphinx Style
-====================
-
-This repository contains sphinx styles Kenneth Reitz uses in most of
-his projects. It is a derivative of Mitsuhiko's themes for Flask and Flask related
-projects. To use this style in your Sphinx documentation, follow
-this guide:
-
-1. put this folder as _themes into your docs folder. Alternatively
- you can also use git submodules to check out the contents there.
-
-2. add this to your conf.py: ::
-
- sys.path.append(os.path.abspath('_themes'))
- html_theme_path = ['_themes']
- html_theme = 'flask'
-
-The following themes exist:
-
-**kr**
- the standard flask documentation theme for large projects
-
-**kr_small**
- small one-page theme. Intended to be used by very small addon libraries.
-
diff --git a/docs/_themes/kr/layout.html b/docs/_themes/kr/layout.html
deleted file mode 100644
index 54f270d0b..000000000
--- a/docs/_themes/kr/layout.html
+++ /dev/null
@@ -1,50 +0,0 @@
-{%- extends "basic/layout.html" %}
-{%- block extrahead %}
- {{ super() }}
- {% if theme_touch_icon %}
-
- {% endif %}
-
-{% endblock %}
-{%- block relbar2 %}{% endblock %}
-{%- block footer %}
-
-
-
-
-
-
-
-
-
-
-
-{%- endblock %}
diff --git a/docs/_themes/kr/relations.html b/docs/_themes/kr/relations.html
deleted file mode 100644
index 3bbcde85b..000000000
--- a/docs/_themes/kr/relations.html
+++ /dev/null
@@ -1,19 +0,0 @@
-
- {% endif %}
-{% endblock %}
-{# do not display relbars #}
-{% block relbar1 %}{% endblock %}
-{% block relbar2 %}
- {% if theme_github_fork %}
-
- {% endif %}
-{% endblock %}
-{% block sidebar1 %}{% endblock %}
-{% block sidebar2 %}{% endblock %}
diff --git a/docs/_themes/kr_small/static/flasky.css_t b/docs/_themes/kr_small/static/flasky.css_t
deleted file mode 100644
index fe2141c56..000000000
--- a/docs/_themes/kr_small/static/flasky.css_t
+++ /dev/null
@@ -1,287 +0,0 @@
-/*
- * flasky.css_t
- * ~~~~~~~~~~~~
- *
- * Sphinx stylesheet -- flasky theme based on nature theme.
- *
- * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
- */
-
-@import url("basic.css");
-
-/* -- page layout ----------------------------------------------------------- */
-
-body {
- font-family: 'Georgia', serif;
- font-size: 17px;
- color: #000;
- background: white;
- margin: 0;
- padding: 0;
-}
-
-div.documentwrapper {
- float: left;
- width: 100%;
-}
-
-div.bodywrapper {
- margin: 40px auto 0 auto;
- width: 700px;
-}
-
-hr {
- border: 1px solid #B1B4B6;
-}
-
-div.body {
- background-color: #ffffff;
- color: #3E4349;
- padding: 0 30px 30px 30px;
-}
-
-img.floatingflask {
- padding: 0 0 10px 10px;
- float: right;
-}
-
-div.footer {
- text-align: right;
- color: #888;
- padding: 10px;
- font-size: 14px;
- width: 650px;
- margin: 0 auto 40px auto;
-}
-
-div.footer a {
- color: #888;
- text-decoration: underline;
-}
-
-div.related {
- line-height: 32px;
- color: #888;
-}
-
-div.related ul {
- padding: 0 0 0 10px;
-}
-
-div.related a {
- color: #444;
-}
-
-/* -- body styles ----------------------------------------------------------- */
-
-a {
- color: #004B6B;
- text-decoration: underline;
-}
-
-a:hover {
- color: #6D4100;
- text-decoration: underline;
-}
-
-div.body {
- padding-bottom: 40px; /* saved for footer */
-}
-
-div.body h1,
-div.body h2,
-div.body h3,
-div.body h4,
-div.body h5,
-div.body h6 {
- font-family: 'Garamond', 'Georgia', serif;
- font-weight: normal;
- margin: 30px 0px 10px 0px;
- padding: 0;
-}
-
-{% if theme_index_logo %}
-div.indexwrapper h1 {
- text-indent: -999999px;
- background: url({{ theme_index_logo }}) no-repeat center center;
- height: {{ theme_index_logo_height }};
-}
-{% endif %}
-
-div.body h2 { font-size: 180%; }
-div.body h3 { font-size: 150%; }
-div.body h4 { font-size: 130%; }
-div.body h5 { font-size: 100%; }
-div.body h6 { font-size: 100%; }
-
-a.headerlink {
- color: white;
- padding: 0 4px;
- text-decoration: none;
-}
-
-a.headerlink:hover {
- color: #444;
- background: #eaeaea;
-}
-
-div.body p, div.body dd, div.body li {
- line-height: 1.4em;
-}
-
-div.admonition {
- background: #fafafa;
- margin: 20px -30px;
- padding: 10px 30px;
- border-top: 1px solid #ccc;
- border-bottom: 1px solid #ccc;
-}
-
-div.admonition p.admonition-title {
- font-family: 'Garamond', 'Georgia', serif;
- font-weight: normal;
- font-size: 24px;
- margin: 0 0 10px 0;
- padding: 0;
- line-height: 1;
-}
-
-div.admonition p.last {
- margin-bottom: 0;
-}
-
-div.highlight{
- background-color: white;
-}
-
-dt:target, .highlight {
- background: #FAF3E8;
-}
-
-div.note {
- background-color: #eee;
- border: 1px solid #ccc;
-}
-
-div.seealso {
- background-color: #ffc;
- border: 1px solid #ff6;
-}
-
-div.topic {
- background-color: #eee;
-}
-
-div.warning {
- background-color: #ffe4e4;
- border: 1px solid #f66;
-}
-
-p.admonition-title {
- display: inline;
-}
-
-p.admonition-title:after {
- content: ":";
-}
-
-pre, tt {
- font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
- font-size: 0.85em;
-}
-
-img.screenshot {
-}
-
-tt.descname, tt.descclassname {
- font-size: 0.95em;
-}
-
-tt.descname {
- padding-right: 0.08em;
-}
-
-img.screenshot {
- -moz-box-shadow: 2px 2px 4px #eee;
- -webkit-box-shadow: 2px 2px 4px #eee;
- box-shadow: 2px 2px 4px #eee;
-}
-
-table.docutils {
- border: 1px solid #888;
- -moz-box-shadow: 2px 2px 4px #eee;
- -webkit-box-shadow: 2px 2px 4px #eee;
- box-shadow: 2px 2px 4px #eee;
-}
-
-table.docutils td, table.docutils th {
- border: 1px solid #888;
- padding: 0.25em 0.7em;
-}
-
-table.field-list, table.footnote {
- border: none;
- -moz-box-shadow: none;
- -webkit-box-shadow: none;
- box-shadow: none;
-}
-
-table.footnote {
- margin: 15px 0;
- width: 100%;
- border: 1px solid #eee;
-}
-
-table.field-list th {
- padding: 0 0.8em 0 0;
-}
-
-table.field-list td {
- padding: 0;
-}
-
-table.footnote td {
- padding: 0.5em;
-}
-
-dl {
- margin: 0;
- padding: 0;
-}
-
-dl dd {
- margin-left: 30px;
-}
-
-pre {
- padding: 0;
- margin: 15px -30px;
- padding: 8px;
- line-height: 1.3em;
- padding: 7px 30px;
- background: #eee;
- border-radius: 2px;
- -moz-border-radius: 2px;
- -webkit-border-radius: 2px;
-}
-
-dl pre {
- margin-left: -60px;
- padding-left: 60px;
-}
-
-tt {
- background-color: #ecf0f3;
- color: #222;
- /* padding: 1px 2px; */
-}
-
-tt.xref, a tt {
- background-color: #FBFBFB;
-}
-
-a:hover tt {
- background: #EEE;
-}
diff --git a/docs/_themes/kr_small/theme.conf b/docs/_themes/kr_small/theme.conf
deleted file mode 100644
index 542b46251..000000000
--- a/docs/_themes/kr_small/theme.conf
+++ /dev/null
@@ -1,10 +0,0 @@
-[theme]
-inherit = basic
-stylesheet = flasky.css
-nosidebar = true
-pygments_style = flask_theme_support.FlaskyStyle
-
-[options]
-index_logo = ''
-index_logo_height = 120px
-github_fork = ''
diff --git a/docs/conf.py b/docs/conf.py
index f5effd924..d732ac29f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -11,7 +11,9 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys, os
+import datetime
+import os
+import sys
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -45,8 +47,11 @@
master_doc = 'index'
# General information about the project.
+current_year = datetime.datetime.now().year
project = u'pythonguide'
-copyright = u'2013. A Kenneth Reitz Project. Creative Commons Share-Alike 3.0'
+copyright = (u'2011-{} Kenneth Reitz'
+ ' & Real Python.'
+ ' CC BY-NC-SA 3.0').format(current_year)
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -69,7 +74,10 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = [
+ '_build',
+ '_themes/*.rst', # Excluded due to README.rst in _themes/
+]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
@@ -96,12 +104,19 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = 'kr'
+html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-#html_theme_options = {}
+html_theme_options = {
+ 'show_powered_by': False,
+ 'github_user': 'realpython',
+ 'github_repo': 'python-guide',
+ 'github_banner': True,
+ 'show_related': False,
+ 'note_bg': '#FFF59C',
+}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['_themes']
@@ -137,9 +152,9 @@
# Custom sidebar templates, maps document names to template names.
html_sidebars = {
- 'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'],
+ 'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html', 'hacks.html'],
'**': ['sidebarlogo.html', 'localtoc.html', 'relations.html',
- 'sourcelink.html', 'searchbox.html']
+ 'sourcelink.html', 'searchbox.html', 'hacks.html']
}
# Additional templates that should be rendered to pages, maps page names to
@@ -156,7 +171,7 @@
#html_split_index = False
# If true, links to the reST sources are added to the pages.
-html_show_sourcelink = True
+html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = False
@@ -231,7 +246,7 @@
epub_title = u'pythonguide'
epub_author = u'Kenneth Reitz'
epub_publisher = u'Kenneth Reitz'
-epub_copyright = u'2010, Kenneth Reitz'
+epub_copyright = u'2011–{}, Kenneth Reitz & Real Python'.format(current_year)
# The language of the text. It defaults to the language option
# or en if the language is not set.
@@ -251,12 +266,14 @@
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
-# HTML files shat should be inserted after the pages created by sphinx.
+# HTML files that should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
-#epub_exclude_files = []
+epub_exclude_files = [
+ ('search.html', 'Search'),
+]
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
@@ -267,5 +284,5 @@
todo_include_todos = True
intersphinx_mapping = {
- 'python': ('http://docs.python.org/', None),
+ 'python': ('https://docs.python.org/3', None),
}
diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc
index 7887307a7..29b076197 100644
--- a/docs/contents.rst.inc
+++ b/docs/contents.rst.inc
@@ -1,28 +1,55 @@
-Getting Started
----------------
+Getting Started with Python
+---------------------------
-This part of the guide focuses on setting up your Python environment.
+New to Python? Let's properly setup up your Python environment:
.. toctree::
:maxdepth: 2
starting/which-python
-- Properly Install Python
+- Properly Install Python on your system:
.. toctree::
:maxdepth: 1
+ starting/installation
+ starting/install3/osx
+ starting/install3/win
+ starting/install3/linux
starting/install/osx
starting/install/win
starting/install/linux
+- Using Virtualenvs with Pipenv:
+
+ .. toctree::
+ :maxdepth: 2
+
+ dev/virtualenvs
+
+
+Python Development Environments
+-------------------------------
+
+This part of the guide focuses on the Python development environment,
+and the best-practice tools that are available for writing Python code.
+
+.. toctree::
+ :maxdepth: 2
+
+ dev/env
+ dev/virtualenvs
+ dev/pip-virtualenv
-Writing Great Code
-------------------
-This part of the guide focuses on best practices for writing Python code.
+
+
+Writing Great Python Code
+-------------------------
+
+This part of the guide focuses on the best-practices for writing Python code.
.. toctree::
:maxdepth: 2
@@ -32,13 +59,14 @@ This part of the guide focuses on best practices for writing Python code.
writing/reading
writing/documentation
writing/tests
+ writing/logging
writing/gotchas
writing/license
-Scenario Guide
---------------
+Scenario Guide for Python Applications
+--------------------------------------
This part of the guide focuses on tool and module advice based on
different scenarios.
@@ -58,38 +86,32 @@ different scenarios.
scenarios/speed
scenarios/scientific
scenarios/imaging
+ scenarios/serialization
scenarios/xml
+ scenarios/json
+ scenarios/crypto
+ scenarios/ml
+ scenarios/clibs
-Shipping Great Code
--------------------
+Shipping Great Python Code
+--------------------------
-This part of the guide focuses on deploying your Python code.
+This part of the guide focuses on sharing and deploying your Python code.
.. toctree::
:maxdepth: 2
+ shipping/publishing
shipping/packaging
shipping/freezing
-Development Environment
------------------------
-
-.. toctree::
- :maxdepth: 2
-
- dev/env
- dev/virtualenvs
-
-
-
-
Additional Notes
----------------
This part of the guide, which is mostly prose, begins with some
-background information about Python, then focuses on next steps.
+background information about Python, and then focuses on next steps.
.. toctree::
:maxdepth: 2
@@ -100,12 +122,15 @@ background information about Python, then focuses on next steps.
intro/documentation
intro/news
-
+.. note::
+ Notes defined within all diatonic and chromatic musical scales have been
+ intentionally excluded from this list of additional notes. Additionally,
+ this note.
--------------------------------------
-Contribution notes and legal information are here (for those interested).
+Contribution notes and legal information (for those interested).
.. toctree::
:maxdepth: 2
@@ -113,8 +138,3 @@ Contribution notes and legal information are here (for those interested).
notes/contribute
notes/license
notes/styleguide
-
-
-
-
-
diff --git a/docs/dev/env.rst b/docs/dev/env.rst
index 7ec103539..7da63c0e6 100644
--- a/docs/dev/env.rst
+++ b/docs/dev/env.rst
@@ -1,59 +1,61 @@
Your Development Environment
============================
+.. image:: /_static/photos/33175624924_7febc46cc4_k_d.jpg
+
Text Editors
::::::::::::
-Just about anything which can edit plain text will work for writing Python code,
+Just about anything that can edit plain text will work for writing Python code;
however, using a more powerful editor may make your life a bit easier.
-VIM
+Vim
---
Vim is a text editor which uses keyboard shortcuts for editing instead of menus
-or icons. There exist a couple of plugins and settings for the VIM editor to
+or icons. There are a couple of plugins and settings for the Vim editor to
aid Python development. If you only develop in Python, a good start is to set
the default settings for indentation and line-wrapping to values compliant with
-`PEP 8 `_. In your home directory,
-open a file called `.vimrc` and add the following lines:::
+:pep:`8`. In your home directory, open a file called :file:`.vimrc` and add the
+following lines::
set textwidth=79 " lines longer than 79 columns will be broken
set shiftwidth=4 " operation >> indents 4 columns; << unindents 4 columns
- set tabstop=4 " an hard TAB displays as 4 columns
+ set tabstop=4 " a hard TAB displays as 4 columns
set expandtab " insert spaces when hitting TABs
set softtabstop=4 " insert/delete 4 spaces when hitting a TAB/BACKSPACE
set shiftround " round indent to multiple of 'shiftwidth'
set autoindent " align the new line indent with the previous line
With these settings, newlines are inserted after 79 characters and indentation
-is set to 4 spaces per tab. If you also use VIM for other languages, there is a
-handy plugin at indent_, which handles indentation settings for Python source
-files.
-
-There is also a handy syntax plugin at syntax_ featuring some improvements over
-the syntax file included in VIM 6.1.
-
-These plugins supply you with a basic environment for developing in Python.
-To get the most out of Vim, you should continually check your code for syntax
-errors and PEP8 compliance. Luckily PEP8_ and Pyflakes_ will do this for you.
-If your VIM is compiled with `+python` you can also utilize some very handy
-plugins to do these checks from within the editor.
-
-For PEP8 checking, install the vim-pep8_ plugin, and for pyflakes you can
-install vim-pyflakes_. Now you can map the functions `Pep8()` or `Pyflakes()`
-to any hotkey or action you want in Vim. Both plugins will display errors at
-the bottom of the screen, and provide an easy way to jump to the corresponding
-line. It's very handy to call these functions whenever you save a file. In
-order to do this, add the following lines to your `vimrc`::
-
- autocmd BufWritePost *.py call Pyflakes()
- autocmd BufWritePost *.py call Pep8()
-
-If you are already using syntastic_ you can enable it to run Pyflakes on write
+is set to 4 spaces per tab. If you also use Vim for other languages, there is a
+handy plugin called indent_, which handles indentation settings for Python
+source files.
+
+There is also a handy syntax plugin called syntax_ featuring some improvements
+over the syntax file included in Vim 6.1.
+
+These plugins supply you with a basic environment for developing in Python. To
+get the most out of Vim, you should continually check your code for syntax
+errors and PEP8 compliance. Luckily pycodestyle_ and Pyflakes_ will do this
+for you. If your Vim is compiled with ``+python`` you can also utilize some
+very handy plugins to do these checks from within the editor.
+
+For PEP8 checking and pyflakes, you can install vim-flake8_. Now you can map the
+function ``Flake8`` to any hotkey or action you want in Vim. The plugin will
+display errors at the bottom of the screen, and provide an easy way to jump to
+the corresponding line. It's very handy to call this function whenever you save
+a file. In order to do this, add the following line to your
+:file:`.vimrc`::
+
+ autocmd BufWritePost *.py call Flake8()
+
+If you are already using syntastic_, you can set it to run Pyflakes on write
and show errors and warnings in the quickfix window. An example configuration
-to do that which also shows status and warning messages in the statusbar would be::
+to do that which also shows status and warning messages in the statusbar would
+be::
set statusline+=%#warningmsg#
set statusline+=%{SyntasticStatuslineFlag()}
@@ -61,64 +63,89 @@ to do that which also shows status and warning messages in the statusbar would b
let g:syntastic_auto_loc_list=1
let g:syntastic_loc_list_height=5
+
Python-mode
^^^^^^^^^^^
-Python-mode_ is a complex solution in VIM for working with python code.
+Python-mode_ is a complex solution for working with Python code in Vim.
It has:
-- Asynchronous Python code checking (pylint, pyflakes, pep8, mccabe) in any combination
+- Asynchronous Python code checking (``pylint``, ``pyflakes``, ``pycodestyle``, ``mccabe``) in any combination
- Code refactoring and autocompletion with Rope
- Fast Python folding
- Virtualenv support
-- Search by Python documentation and run Python code
-- Auto PEP8 error fixes
+- Search through Python documentation and run Python code
+- Auto pycodestyle_ error fixes
And more.
+SuperTab
+^^^^^^^^
+
+SuperTab_ is a small Vim plugin that makes code completion more convenient by
+using ```` key or any other customized keys.
+
.. _indent: http://www.vim.org/scripts/script.php?script_id=974
.. _syntax: http://www.vim.org/scripts/script.php?script_id=790
-.. _Pyflakes: http://pypi.python.org/pypi/pyflakes/
-.. _vim-pyflakes: https://github.com/nvie/vim-pyflakes
-.. _PEP8: http://pypi.python.org/pypi/pep8/
-.. _vim-pep8: https://github.com/nvie/vim-pep8
-.. _syntastic: https://github.com/scrooloose/syntastic
-.. _Python-mode: https://github.com/klen/python-mode
-
-.. todo:: add supertab notes
+.. _Pyflakes: http://pypi.org/project/pyflakes/
+.. _pycodestyle: https://pypi.org/project/pycodestyle/
+.. _syntastic: https://github.com/vim-syntastic/syntastic
+.. _Python-mode: https://github.com/python-mode/python-mode
+.. _SuperTab: http://www.vim.org/scripts/script.php?script_id=1643
+.. _vim-flake8: https://github.com/nvie/vim-flake8
Emacs
-----
-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.
+Emacs is another powerful text editor. It is 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.
-2. Python ships with an alternate version:
- `python-mode.el `_
-3. Fabián Ezequiel Gallina's `python.el `_
- provides nice functionality and behavior out of the box
+1. Emacs itself comes with a Python mode.
-.. _Python Programming in Emacs: http://emacswiki.org/emacs/PythonProgrammingInEmacs
+.. _Python Programming in Emacs: https://www.emacswiki.org/emacs/PythonProgrammingInEmacs
TextMate
--------
-"`TextMate `_ brings Apple's approach to operating
-systems into the world of text editors. By bridging UNIX underpinnings and GUI,
-TextMate cherry-picks the best of both worlds to the benefit of expert
-scripters and novice users alike."
+ `TextMate `_ brings Apple's approach to operating
+ systems into the world of text editors. By bridging Unix underpinnings and
+ GUI, TextMate cherry-picks the best of both worlds to the benefit of expert
+ scripters and novice users alike.
Sublime Text
------------
-"`Sublime Text `_ is a sophisticated text editor
-for code, html and prose. You'll love the slick user interface and
-extraordinary features."
+ `Sublime Text `_ is a sophisticated text
+ editor for code, markup, and prose. You'll love the slick user interface,
+ extraordinary features, and amazing performance.
Sublime Text has excellent support for editing Python code and uses Python for
-its plugin API.
+its plugin API. It also has a diverse variety of plugins,
+`some of which `_ allow for
+in-editor PEP8 checking and code "linting".
+
+Atom
+----
+
+ `Atom `_ is a hackable text editor for the 21st century,
+ built on atom-shell, and based on everything we love about our favorite
+ editors.
+
+Atom is web native (HTML, CSS, JS), focusing on modular design and easy plugin
+development. It comes with native package control and a plethora of packages.
+Recommended for Python development is
+`Linter `_ combined with
+`linter-flake8 `_.
+
+Python (on Visual Studio Code)
+------------------------------
+
+`Python for Visual Studio `_ is an extension for the `Visual Studio Code `_.
+This is a free, lightweight, open source code editor, 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.
IDEs
::::
@@ -128,32 +155,45 @@ 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 `_. There are two
+versions of PyCharm: Professional Edition (Free 30-day trial) and Community
+Edition (Apache 2.0 License) with fewer features.
+Enthought Canopy
+----------------
+`Enthought Canopy `_ is a Python
+IDE which is focused towards Scientists and Engineers as it provides pre
+installed libraries for data analysis.
+
Eclipse
-------
The most popular Eclipse plugin for Python development is Aptana's
-`PyDev `_.
+`PyDev `_.
Komodo IDE
----------
-`Komodo IDE `_ is developed by
-ActiveState and is a commercial IDE for Windows, Mac and Linux.
+
+`Komodo IDE `_ is developed by
+ActiveState and is a commercial IDE for Windows, Mac, and Linux.
+`KomodoEdit `_ is the open source
+alternative.
Spyder
------
-`Spyder `_ is an IDE specifically geared
-toward working with scientific Python libraries (namely `Scipy `_).
-It includes integration with pyflakes_, `pylint `_,
-and `rope `_.
+`Spyder `_ is an IDE specifically geared
+toward working with scientific Python libraries (namely
+`SciPy `_). It includes integration with pyflakes_,
+`pylint `_ and
+`rope `_.
-Spyder is open-source (free), offers code completion, syntax highlighting,
-class and function browser, and object inspection.
+Spyder is open source (free), offers code completion, syntax highlighting,
+a class and function browser, and object inspection.
WingIDE
@@ -171,112 +211,75 @@ NINJA-IDE
`NINJA-IDE `_ (from the recursive acronym: "Ninja-IDE
Is Not Just Another IDE") is a cross-platform IDE, specially designed to build
-Python applications, and runs on Linux/X11, Mac OS X and Windows desktop operating
-systems. Installers for these platforms can be downloaded from the website.
-
-NINJA-IDE is open-source software (GPLv3 licence) and is developed in Python and
-Qt. The source files can be downloaded from `GitHub `_.
-
-Interpreter Tools
-:::::::::::::::::
-
-
-virtualenv
-----------
+Python applications, and runs on Linux/X11, Mac OS X, and Windows desktop
+operating systems. Installers for these platforms can be downloaded from the
+website.
-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.
+NINJA-IDE is open source software (GPLv3 licence) and is developed
+in Python and Qt. The source files can be downloaded from
+`GitHub `_.
-`virtualenv `_ creates
-a folder which contains all the necessary executables to contain the
-packages that a Python project would need. An example workflow is given.
-Install virtualenv::
+Eric (The Eric Python IDE)
+--------------------------
- $ pip install virtualenv
+`Eric `_ is a full featured Python IDE
+offering source code autocompletion, syntax highlighting, support for version
+control systems, Python 3 support, integrated web browser, python shell,
+integrated debugger, and a flexible plug-in system. Written in Python, it is
+based on the Qt GUI toolkit, integrating the Scintilla editor control. Eric
+is an open source software project (GPLv3 licence) with more than ten years of
+active development.
+Mu
+--
-Create a virtual environment for a project::
+`Mu `_ is a minimalist Python IDE which can run Python 3 code
+locally and can also deploy code to the BBC micro:bit and to Adafruit boards running
+CircuitPython.
- $ cd my_project
- $ virtualenv venv
+Intended for beginners, mu includes a Python 3 interpreter, and is easy to install
+on Windows, OS/X and Linux. It runs well on the Raspberry Pi.
-``virtualenv venv`` will create a folder in the current directory
-which will contain the Python executable files, and a copy of the ``pip``
-library which you can use to install other packages. The name of the
-virtual environment (in this case, it was ``venv``) can be anything;
-omitting the name will place the files in the current directory instead.
+There's an active support community on gitter.
-To start using the virtual environment, run::
- $ 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 placed in the venv folder, isolated from the global
-Python installation. Install packages as usual::
-
- $ pip install requests
-
-To stop using an environment simply type ``deactivate``. To remove the
-environment, just remove the directory it was installed into. (In this
-case, it would be ``rm -rf venv``).
-
-Other Notes
-^^^^^^^^^^^
-
-Running ``virtualenv`` with the option ``--no-site-packages`` will not
-include the packages that are installed globally. This can be useful
-for keeping the package list clean in case it needs to be accessed later.
-[This is the default behavior for ``virtualenv`` 1.7 and later.]
-
-In order to keep your environment consistent, it's a good idea to "freeze"
-the current state of the environment packages. To do this, run
-
-::
-
- $ pip freeze > requirements.txt
-
-This will create a ``requirements.txt`` file, which contains a simple
-list of all the packages in the current environment, and their respective
-versions. Later, when a different developer (or you, if you need to re-
-create the environment) can install the same packages, with the same
-versions by running
-
-::
-
- $ pip install -r requirements.txt
-
-This can help ensure consistency across installations, across deployments,
-and across developers.
-
-Lastly, remember to exclude the virtual environment folder from source
-control by adding it to the ignore list.
-
-virtualenvwrapper
------------------
-
-`Virtualenvwrapper `_ makes
-virtualenv a pleasure to use by wrapping the command line API with a nicer CLI.
+Interpreter Tools
+:::::::::::::::::
-::
- $ pip install virtualenvwrapper
+Virtual Environments
+--------------------
+Virtual Environments provide a powerful way to isolate project package dependencies. This means that you can use packages particular to a Python project without installing them system wide and thus avoiding potential version conflicts.
-Put this into your `~/.bash_profile` (Linux/Mac) file:
+To start using and see more information:
+`Virtual Environments `_ docs.
-::
- $ export VIRTUALENVWRAPPER_VIRTUALENV_ARGS='--no-site-packages'
+pyenv
+-----
-This will prevent your virtualenvs from relying on your (global) site packages
-directory, so that they are completely separate..
-[note: This is the default behavior for ``virtualenv`` 1.7 and later]
+`pyenv `_ is a tool to allow multiple versions
+of the Python interpreter to be installed at the same time. This solves the
+problem of having different projects requiring different versions of Python.
+For example, it becomes very easy to install Python 2.7 for compatibility in
+one project, while still using Python 3.4 as the default interpreter.
+pyenv isn't just limited to the CPython versions – it will also install PyPy,
+Anaconda, miniconda, stackless, Jython, and IronPython interpreters.
+
+pyenv works by filling a ``shims`` directory with fake versions of the Python
+interpreter (plus other tools like ``pip`` and ``2to3``). When the system
+looks for a program named ``python``, it looks inside the ``shims`` directory
+first, and uses the fake version, which in turn passes the command on to
+pyenv. pyenv then works out which version of Python should be run based on
+environment variables, ``.python-version`` files, and the global default.
+
+pyenv isn't a tool for managing virtual environments, but there is the plugin
+`pyenv-virtualenv `_ which automates
+the creation of different environments, and also makes it possible to use the
+existing pyenv tools to switch to different environments based on environment
+variables or ``.python-version`` files.
Other Tools
:::::::::::
@@ -284,12 +287,11 @@ Other Tools
IDLE
----
-`IDLE `_ is an integrated
-development environment that is part of Python standard library. It is
-completely written in Python and uses the Tkinter GUI toolkit. Though IDLE
-is not suited for full-blown development using Python, it is quite
-helpful to try out small Python snippets and experiment with different
-features in Python.
+:ref:`IDLE ` is an integrated development environment that is
+part of the Python standard distribution. It is completely written in Python and uses
+the Tkinter GUI toolkit. Though IDLE is not suited for full-blown development
+using Python, it is quite helpful to try out small Python snippets and
+experiment with different features in Python.
It provides the following features:
@@ -304,35 +306,60 @@ IPython
`IPython `_ provides a rich toolkit to help you make the
most out of using Python interactively. Its main components are:
-* Powerful Python shells (terminal- and Qt-based).
+* Powerful Python shells (terminal- and Qt-based)
* A web-based notebook with the same core features but support for rich media,
- text, code, mathematical expressions and inline plots.
-* Support for interactive data visualization and use of GUI toolkits.
-* Flexible, embeddable interpreters to load into your own projects.
-* Tools for high level and interactive parallel computing.
+ text, code, mathematical expressions and inline plots
+* Support for interactive data visualization and use of GUI toolkits
+* Flexible, embeddable interpreters to load into your own projects
+* Tools for high level and interactive parallel computing
-::
+.. code-block:: console
$ pip install ipython
+To download and install IPython with all its optional dependencies for the notebook, qtconsole, tests, and other functionalities:
+.. code-block:: console
+
+ $ pip install ipython[all]
BPython
-------
-`bpython `_ is an alternative interface to the
-Python interpreter for Unix-like operating systems. It has the following features:
+`bpython `_ is an alternative interface to the
+Python interpreter for Unix-like operating systems. It has the following
+features:
-* In-line syntax highlighting.
-* Readline-like autocomplete with suggestions displayed as you type.
-* Expected parameter list for any Python function.
-* "Rewind" function to pop the last line of code from memory and re-evaluate.
-* Send entered code off to a pastebin.
-* Save entered code to a file.
-* Auto-indentation.
-* Python 3 support.
+* In-line syntax highlighting
+* Readline-like autocomplete with suggestions displayed as you type
+* Expected parameter list for any Python function
+* "Rewind" function to pop the last line of code from memory and re-evaluate
+* Send entered code off to a pastebin
+* Save entered code to a file
+* Auto-indentation
+* Python 3 support
-::
+.. code-block:: console
$ pip install bpython
+ptpython
+--------
+
+`ptpython `_ is a REPL build
+on top of the `prompt_toolkit `_
+library. It is considered to be an alternative to BPython_. Features include:
+
+* Syntax highlighting
+* Autocompletion
+* Multiline editing
+* Emacs and Vim Modes
+* Embedding REPL inside of your code
+* Syntax validation
+* Tab pages
+* Support for integrating with IPython_'s shell, by installing IPython
+ (``pip install ipython``) and running ``ptipython``.
+
+.. code-block:: console
+
+ $ pip install ptpython
diff --git a/docs/dev/pip-virtualenv.rst b/docs/dev/pip-virtualenv.rst
new file mode 100644
index 000000000..667f30c7a
--- /dev/null
+++ b/docs/dev/pip-virtualenv.rst
@@ -0,0 +1,137 @@
+.. _pip-virtualenv:
+
+Further Configuration of pip and Virtualenv
+===========================================
+
+.. image:: /_static/photos/34018732105_f0e6758859_k_d.jpg
+
+Requiring an active virtual environment for ``pip``
+---------------------------------------------------
+
+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
+line to your :file:`~/.bashrc` file:
+
+.. code-block:: console
+
+ export PIP_REQUIRE_VIRTUALENV=true
+
+After saving this change and sourcing the :file:`~/.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 can also do this configuration by editing your :file:`pip.conf` or
+:file:`pip.ini` file. :file:`pip.conf` is used by Unix and Mac OS X operating
+systems and it can be found at:
+
+.. code-block:: console
+
+ $HOME/.pip/pip.conf
+
+Similarly, the :file:`pip.ini` file is used by Windows operating systems and it
+can be found at:
+
+.. code-block:: console
+
+ %USERPROFILE%\pip\pip.ini
+
+If you don't have a :file:`pip.conf` or :file:`pip.ini` file at these locations,
+you can create a new file with the correct name for your operating system.
+
+If you already have a configuration file, just add the following line under the
+``[global]`` settings to require an active virtual environment:
+
+.. code-block:: console
+
+ require-virtualenv = true
+
+If you did not have a configuration file, you will need to create a new one and
+add the following lines to this new file:
+
+.. code-block:: console
+
+ [global]
+ require-virtualenv = true
+
+
+You will of course need to install some packages globally (usually ones that
+you use across different projects consistently) and this can be accomplished by
+adding the following to your :file:`~/.bashrc` file:
+
+.. code-block:: console
+
+ gpip() {
+ PIP_REQUIRE_VIRTUALENV=false pip "$@"
+ }
+
+After saving the changes and sourcing your :file:`~/.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 to install packages globally with pip.
+
+Caching packages for future use
+-------------------------------
+
+Every developer has preferred libraries and when you are working on a lot of
+different projects, you are bound to have some overlap between the libraries
+that you use. For example, you may be using the ``requests`` library in a lot
+of different projects.
+
+It is surely unnecessary to re-download the same packages/libraries each time
+you start working on a new project (and in a new virtual environment as a
+result). Fortunately, starting with version 6.0, pip provides an `on-by-default
+caching mechanism
+`_ that doesn't
+need any configuration.
+
+When using older versions, you can configure pip in such a way that it tries to
+reuse already installed packages, too.
+
+On Unix systems, you can add the following line to your :file:`.bashrc` or
+:file:`.bash_profile` file.
+
+.. code-block:: console
+
+ export PIP_DOWNLOAD_CACHE=$HOME/.pip/cache
+
+You can set the path to anywhere you like (as long as you have write
+access). After adding this line, ``source`` your :file:`.bashrc`
+(or :file:`.bash_profile`) file and you will be all set.
+
+Another way of doing the same configuration is via the :file:`pip.conf` or
+:file:`pip.ini` files, depending on your system. If you are on Windows, you can
+add the following line to your :file:`pip.ini` file under ``[global]`` settings:
+
+.. code-block:: console
+
+ download-cache = %USERPROFILE%\pip\cache
+
+Similarly, on Unix systems you should simply add the following line to your
+:file:`pip.conf` file under ``[global]`` settings:
+
+.. code-block:: console
+
+ download-cache = $HOME/.pip/cache
+
+Even though you can use any path you like to store your cache, it is recommended
+that you create a new folder *in* the folder where your :file:`pip.conf` or
+:file:`pip.ini` file lives. If you don't trust yourself with all of this path
+voodoo, just use the values provided here and you will be fine.
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
index ee6ace244..fe6bd3f9e 100644
--- a/docs/dev/virtualenvs.rst
+++ b/docs/dev/virtualenvs.rst
@@ -1,36 +1,257 @@
-Virtual Environments
-====================
+.. _virtualenvironments-ref:
-A Virtual Environment, put simply, is an isolated working copy of Python which
-allows you to work on a specific project without worry of affecting other
-projects.
+Pipenv & Virtual Environments
+=============================
-For example, you can work on a project which requires Django 1.3 while also
-maintaining a project which requires Django 1.0.
+.. image:: /_static/photos/35294660055_42c02b2316_k_d.jpg
-virtualenv
+This tutorial walks you through installing and using Python packages.
+
+It will show you how to install and use the necessary tools and make strong
+recommendations on best practices. Keep in mind that Python is used for a great
+many different purposes, and precisely how you want to manage your dependencies
+may change based on how you decide to publish your software. The guidance
+presented here is most directly applicable to the development and deployment of
+network services (including web applications), but is also very well suited to
+managing development and testing environments for any kind of project.
+
+.. Note:: This guide is written for Python 3, however, these instructions
+ should work fine on Python 2.7—if you are still using it, for some reason.
+
+
+Make sure you've got Python & pip
+---------------------------------
+
+Before you go any further, make sure you have Python and that it's available
+from your command line. You can check this by simply running:
+
+.. code-block:: console
+
+ $ python --version
+
+You should get some output like ``3.6.2``. If you do not have Python, please
+install the latest 3.x version from `python.org`_ or refer to the
+`Installing Python`_ section of this guide.
+
+.. Note:: If you're newcomer and you get an error like this:
+
+ .. code-block:: python
+
+ >>> python
+ Traceback (most recent call last):
+ File "", line 1, in
+ NameError: name 'python' is not defined
+
+ It's because this command is intended to be run in a *shell* (also called
+ a *terminal* or *console*). See the Python for Beginners
+ `getting started tutorial`_ for an introduction to using your operating
+ system's shell and interacting with Python.
+
+Additionally, you'll need to make sure you have `pip`_ available. You can
+check this by running:
+
+.. code-block:: console
+
+ $ pip --version
+
+If you installed Python from source, with an installer from `python.org`_, or
+via `Homebrew`_ you should already have pip. If you're on Linux and installed
+using your OS package manager, you may have to `install pip `_ separately.
+
+.. _getting started tutorial: https://opentechschool.github.io/python-beginners/en/getting_started.html#what-is-python-exactly
+.. _python.org: https://python.org
+.. _pip: https://pypi.org/project/pip/
+.. _Homebrew: https://brew.sh
+.. _Installing Python: https://docs.python-guide.org/starting/installation/
+
+
+Installing Pipenv
+-----------------
+
+`Pipenv`_ is a dependency manager for Python projects. If you're familiar
+with Node.js' `npm`_ or Ruby's `bundler`_, it is similar in spirit to those
+tools. While `pip`_ can install Python packages, Pipenv is recommended as
+it's a higher-level tool that simplifies dependency management for common use
+cases.
+
+Use ``pip`` to install Pipenv:
+
+.. code-block:: console
+
+ $ pip install --user pipenv
+
+
+.. Note:: This does a `user installation`_ to prevent breaking any system-wide
+ packages. If ``pipenv`` isn't available in your shell after installation,
+ you'll need to add the `user base`_'s binary directory to your ``PATH``.
+
+ On Linux and macOS you can find the user base binary directory by running
+ ``python -m site --user-base`` and adding ``bin`` to the end. For example,
+ this will typically print ``~/.local`` (with ``~`` expanded to the
+ absolute path to your home directory) so you'll need to add
+ ``~/.local/bin`` to your ``PATH``. You can set your ``PATH`` permanently by
+ `modifying ~/.profile`_.
+
+ On Windows you can find the user base binary directory by running
+ ``py -m site --user-site`` and replacing ``site-packages`` with
+ ``Scripts``. For example, this could return
+ ``C:\Users\Username\AppData\Roaming\Python36\site-packages`` so you would
+ need to set your ``PATH`` to include
+ ``C:\Users\Username\AppData\Roaming\Python36\Scripts``. You can set your
+ user ``PATH`` permanently in the `Control Panel`_. You may need to log
+ out for the ``PATH`` changes to take effect.
+
+.. _Pipenv: https://pipenv.kennethreitz.org/
+.. _npm: https://www.npmjs.com/
+.. _bundler: http://bundler.io/
+.. _user base: https://docs.python.org/3/library/site.html#site.USER_BASE
+.. _user installation: https://pip.pypa.io/en/stable/user_guide/#user-installs
+.. _modifying ~/.profile: https://stackoverflow.com/a/14638025
+.. _Control Panel: https://msdn.microsoft.com/en-us/library/windows/desktop/bb776899(v=vs.85).aspx
+
+Installing packages for your project
+------------------------------------
+
+Pipenv manages dependencies on a per-project basis. To install packages,
+change into your project's directory (or just an empty directory for this
+tutorial) and run:
+
+.. code-block:: console
+
+ $ cd project_folder
+ $ pipenv install requests
+
+Pipenv will install the excellent `Requests`_ library and create a ``Pipfile``
+for you in your project's directory. The `Pipfile`_ is used to track which
+dependencies your project needs in case you need to re-install them, such as
+when you share your project with others. You should get output similar to this
+(although the exact paths shown will vary):
+
+.. _Pipfile: https://github.com/pypa/pipfile
+
+.. code-block:: text
+
+ Creating a Pipfile for this project...
+ Creating a virtualenv for this project...
+ Using base prefix '/usr/local/Cellar/python3/3.6.2/Frameworks/Python.framework/Versions/3.6'
+ New python executable in ~/.local/share/virtualenvs/tmp-agwWamBd/bin/python3.6
+ Also creating executable in ~/.local/share/virtualenvs/tmp-agwWamBd/bin/python
+ Installing setuptools, pip, wheel...done.
+
+ Virtualenv location: ~/.local/share/virtualenvs/tmp-agwWamBd
+ Installing requests...
+ Collecting requests
+ Using cached requests-2.18.4-py2.py3-none-any.whl
+ Collecting idna<2.7,>=2.5 (from requests)
+ Using cached idna-2.6-py2.py3-none-any.whl
+ Collecting urllib3<1.23,>=1.21.1 (from requests)
+ Using cached urllib3-1.22-py2.py3-none-any.whl
+ Collecting chardet<3.1.0,>=3.0.2 (from requests)
+ Using cached chardet-3.0.4-py2.py3-none-any.whl
+ Collecting certifi>=2017.4.17 (from requests)
+ Using cached certifi-2017.7.27.1-py2.py3-none-any.whl
+ Installing collected packages: idna, urllib3, chardet, certifi, requests
+ Successfully installed certifi-2017.7.27.1 chardet-3.0.4 idna-2.6 requests-2.18.4 urllib3-1.22
+
+ Adding requests to Pipfile's [packages]...
+ P.S. You have excellent taste! ✨ 🰠✨
+
+.. _Requests: https://requests.readthedocs.io/en/latest/
+
+
+Using installed packages
+------------------------
+
+Now that Requests is installed you can create a simple ``main.py`` file to
+use it:
+
+.. code-block:: python
+
+ import requests
+
+ response = requests.get('https://httpbin.org/ip')
+
+ print('Your IP is {0}'.format(response.json()['origin']))
+
+Then you can run this script using ``pipenv run``:
+
+.. code-block:: console
+
+ $ pipenv run python main.py
+
+You should get output similar to this:
+
+.. code-block:: text
+
+ Your IP is 8.8.8.8
+
+Using ``$ pipenv run`` ensures that your installed packages are available to
+your script. It's also possible to spawn a new shell that ensures all commands
+have access to your installed packages with ``$ pipenv shell``.
+
+
+Next steps
----------
-`virtualenv `_ is a tool to create
-isolated Python environments.
+Congratulations, you now know how to install and use Python packages! ✨ 🰠✨
+
+
-Install it via pip:
+Lower level: 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.
+
+It can be used standalone, in place of Pipenv.
+
+Install virtualenv via pip:
.. code-block:: console
$ pip install virtualenv
+Test your installation:
+
+.. code-block:: console
+
+ $ virtualenv --version
+
Basic Usage
-~~~~~~~~~~~
+-----------
-1. Create a virtual environment:
+1. Create a virtual environment for a project:
.. code-block:: console
+ $ cd project_folder
$ virtualenv venv
+``virtualenv venv`` will create a folder in the current directory which will
+contain the Python executable files, and a copy of the ``pip`` library which you
+can use to install other packages. The name of the virtual environment (in this
+case, it was ``venv``) can be anything; omitting the name will place the files
+in the current directory instead.
+
+.. note::
+ 'venv' is the general convention used globally. As it is readily available in ignore files (eg: .gitignore')
+
This creates a copy of Python in whichever directory you ran the command in,
-placing it in a folder named ``venv``.
+placing it in a folder named :file:`venv`.
+
+You can also use the Python interpreter of your choice (like
+``python2.7``).
+
+.. code-block:: console
+
+ $ 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/bin/python2.7
2. To begin using the virtual environment, it needs to be activated:
@@ -38,29 +259,83 @@ placing it in a folder named ``venv``.
$ source venv/bin/activate
-You can then begin installing any new modules without affecting the system
-default Python or other virtual environments.
+The name of the current virtual environment will now appear on the left of
+the prompt (e.g. ``(venv)Your-Computer:project_folder 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.
+
+For Windows, the same command mentioned in step 1 can be used to create a virtual environment. However, activating the environment requires a slightly different command.
+
+Assuming that you are in your project directory:
+
+.. code-block:: console
+
+ C:\Users\SomeUser\project_folder> venv\Scripts\activate
+
+Install packages using the ``pip`` command:
+
+.. code-block:: console
+
+ $ pip install requests
3. If you are done working in the virtual environment for the moment, you can
deactivate it:
.. code-block:: console
- $ deactivate
+ $ deactivate
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.
+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
-littered across your system, and its possible you'll forget their names or
+littered across your system, and it's possible you'll forget their names or
where they were placed.
+.. note::
+ Python has included venv module from version 3.3. For more details: `venv `_.
+
+Other Notes
+-----------
+
+Running ``virtualenv`` with the option ``--no-site-packages`` will not
+include the packages that are installed globally. This can be useful
+for keeping the package list clean in case it needs to be accessed later.
+[This is the default behavior for ``virtualenv`` 1.7 and later.]
+
+In order to keep your environment consistent, it's a good idea to "freeze"
+the current state of the environment packages. To do this, run:
+
+.. code-block:: console
+
+ $ pip freeze > requirements.txt
+
+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
+(or you, if you need to re-create the environment) to install the same packages
+using the same versions:
+
+.. code-block:: console
+
+ $ pip install -r requirements.txt
+
+This can help ensure consistency across installations, across deployments,
+and across developers.
+
+Lastly, remember to exclude the virtual environment folder from source
+control by adding it to the ignore list (see :ref:`Version Control Ignores`).
+
+.. _virtualenvwrapper-ref:
+
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,18 +347,17 @@ 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.
+For Windows, you can use the `virtualenvwrapper-win `_.
To install (make sure **virtualenv** is already installed):
.. code-block:: console
- PS> pip install virtualenvwrapper-powershell
- PS> $env:WORKON_HOME="~/Envs"
- PS> mkdir $env:WORKON_HOME
- PS> import-module virtualenvwrapper
+ $ pip install virtualenvwrapper-win
+
+In Windows, the default path for WORKON_HOME is %USERPROFILE%\\Envs
Basic Usage
~~~~~~~~~~~
@@ -92,19 +366,28 @@ Basic Usage
.. code-block:: console
- $ mkvirtualenv venv
+ $ mkvirtualenv project_folder
-This creates the ``venv`` folder inside ``~/Envs``.
+This creates the :file:`project_folder` folder inside :file:`~/Envs`.
2. Work on a virtual environment:
.. code-block:: console
- $ workon venv
+ $ workon project_folder
+
+Alternatively, you can make a project, which creates the virtual environment,
+and also a project directory inside ``$WORKON_HOME``, which is ``cd``-ed into
+when you ``workon project_folder``.
+
+.. code-block:: console
+
+ $ mkproject project_folder
**virtualenvwrapper** provides tab-completion on environment names. It really
helps when you have a lot of environments and have trouble remembering their
names.
+
``workon`` also deactivates whatever environment you are currently in, so you
can quickly switch between environments.
@@ -128,30 +411,31 @@ Other useful commands
``cdvirtualenv``
Navigate into the directory of the currently activated virtual environment,
- so you can browse its ``site-packages``, for example.
+ so you can browse its :file:`site-packages`, for example.
``cdsitepackages``
- Like the above, but directly into ``site-packages`` directory.
+ Like the above, but directly into :file:`site-packages` directory.
``lssitepackages``
- Shows contents of ``site-packages`` directory.
+ Shows contents of :file:`site-packages` directory.
+
+`Full list of virtualenvwrapper commands `_.
+
+virtualenv-burrito
+------------------
-`Full list of virtualenvwrapper commands `_.
+With `virtualenv-burrito `_, you
+can have a working virtualenv + virtualenvwrapper environment in a single command.
-autoenv
+direnv
-------
-When you ``cd`` into a directory containing a ``.env`` `autoenv `_
+When you ``cd`` into a directory containing a :file:`.env`, `direnv `_
automagically activates the environment.
Install it on Mac OS X using ``brew``:
.. code-block:: console
- $ brew install autoenv
-
-And on Linux:
-
-.. code-block:: console
+ $ brew install direnv
- $ git clone git://github.com/kennethreitz/autoenv.git ~/.autoenv
- $ echo 'source ~/.autoenv/activate.sh' >> ~/.bashrc
+On Linux follow the instructions at `direnv.net `_
diff --git a/docs/index.rst b/docs/index.rst
index 19e167222..df7fcb8ed 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,17 +1,33 @@
-.. osxpython documentation master file, created by
+.. pythonguide documentation master file, created by
sphinx-quickstart on Wed Aug 4 22:51:11 2010.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
+.. meta::
+ :description: An opinionated guide to the Python programming language and a best practice handbook for the installation, configuration, and usage of Python on a daily basis.
+
+
+#################################
The Hitchhiker's Guide to Python!
-=================================
+#################################
-Welcome to The Hitchhiker's Guide to Python.
+Greetings, Earthling! Welcome to The Hitchhiker's Guide to Python.
-**This guide is currently under heavy active development.** If you'd like to help, `fork us on GitHub `_!
+**This is a living, breathing guide.** If you'd like to contribute,
+`fork us on GitHub `_!
-This *opinionated* guide exists to provide both novice and expert Python
-developers a best-practice handbook to the installation, configuration, and
+This handcrafted guide exists to provide both novice and expert Python
+developers a best practice handbook for the installation, configuration, and
usage of Python on a daily basis.
+This guide is **opinionated** in a way that is almost, but not quite, entirely
+*unlike* Python's official documentation. You won't find a list of every Python web framework
+available here. Rather, you'll find a nice concise list of highly recommended
+options.
+
+.. note:: The use of **Python 3** is *highly* recommended over Python 2. Consider upgrading your applications and infrastructures if you find yourself *still* using Python 2 in production today. If you are using Python 3, congratulations — you are indeed a person of excellent taste.
+ —*Kenneth Reitz*
+
+Let's get started! But first, let's make sure you know where your towel is.
+
.. include:: contents.rst.inc
diff --git a/docs/intro/community.rst b/docs/intro/community.rst
index 8ae20192d..4ce563658 100644
--- a/docs/intro/community.rst
+++ b/docs/intro/community.rst
@@ -1,18 +1,25 @@
.. _the-community:
+
+#############
The Community
-=============
+#############
+
+.. image:: /_static/photos/34689432801_78d97ecec9_k_d.jpg
+
+****
BDFL
-----
+****
Guido van Rossum, the creator of Python, is often referred to as the BDFL — the
Benevolent Dictator For Life.
-
+**************************
Python Software Foundation
---------------------------
+**************************
+
The mission of the Python Software Foundation is to promote, protect, and
advance the Python programming language, and to support and facilitate the
@@ -21,13 +28,14 @@ growth of a diverse and international community of Python programmers.
`Learn More about the PSF `_.
+****
PEPs
-----
+****
PEPs are *Python Enhancement Proposals*. They describe changes to Python itself,
or the standards around it.
-There are three different types of PEPs (as defined by `PEP1 `_):
+There are three different types of PEPs (as defined by :pep:`1`):
**Standards**
Describes a new feature or implementation.
@@ -45,13 +53,13 @@ Notable PEPs
There are a few PEPs that could be considered required reading:
-- `PEP8 `_: The Python Style Guide.
+- :pep:`8`: The Python Style Guide.
Read this. All of it. Follow it.
-- `PEP20 `_: The Zen of Python.
+- :pep:`20`: The Zen of Python.
A list of 19 statements that briefly explain the philosophy behind Python.
-- `PEP257 `_: Docstring Conventions.
+- :pep:`257`: Docstring Conventions.
Gives guidelines for semantics and conventions associated with Python
docstrings.
@@ -60,27 +68,48 @@ You can read more at `The PEP Index `_.
Submitting a PEP
~~~~~~~~~~~~~~~~
- PEPs are peer-reviewed and accepted/rejected after much discussion. Anyone
- can write and submit a PEP for review.
+PEPs are peer-reviewed and accepted/rejected after much discussion. Anyone
+can write and submit a PEP for review.
- Here's an overview of the PEP acceptance workflow:
+Here's an overview of the PEP acceptance workflow:
- .. image:: http://www.python.org/dev/peps/pep-0001/pep-0001-1.png
+.. image:: ../_static/pep-0001-1.png
+******************
Python Conferences
---------------------------
+******************
The major events for the Python community are developer conferences. The two
most notable conferences are PyCon, which is held in the US, and its European
sibling, EuroPython.
-A comprehensive list of conferences is maintained `at pycon.org `_.
+A comprehensive list of conferences is maintained at `pycon.org `_.
+******************
Python User Groups
---------------------------
+******************
User Groups are where a bunch of Python developers meet to present or talk
about Python topics of interest. A list of local user groups is maintained at
the `Python Software Foundation Wiki `_.
+
+
+******************
+Online Communities
+******************
+
+`PythonistaCafe `_ is an invite-only, online community
+of Python and software development enthusiasts helping each other succeed and grow.
+Think of it as a club of mutual improvement for Pythonistas where a broad range of
+programming questions, career advice, and other topics are discussed every day.
+
+
+*****************
+Python Job Boards
+*****************
+
+`Python Jobs HQ `_ is a Python job board, by Python Developers
+for Python Developers. The site aggregates Python job postings from across the web and
+also allows employers to post Python job openings directly on the site.
diff --git a/docs/intro/documentation.rst b/docs/intro/documentation.rst
index cdc796dc7..887d0982b 100644
--- a/docs/intro/documentation.rst
+++ b/docs/intro/documentation.rst
@@ -1,21 +1,49 @@
+
+
+#############
Documentation
-=============
+#############
+
+.. image:: /_static/photos/33928823133_2f3d32cf32_k_d.jpg
+
+**********************
Official Documentation
-----------------------
+**********************
The official Python Language and Library documentation can be found here:
- - `Python 2.x `_
- - `Python 3.x `_
+ - `Python 2.x `_
+ - `Python 3.x `_
+*************
Read the Docs
--------------
+*************
+
+Read the Docs is a popular community project that hosts documentation
+for open source software. It holds documentation for many Python modules,
+both popular and exotic.
+
+ `Read the Docs `_
+
+
+*****
+pydoc
+*****
+
+:program:`pydoc` is a utility that is installed when you install Python.
+It allows you to quickly retrieve and search for documentation from your
+shell. For example, if you needed a quick refresher on the
+:mod:`time` module, pulling up documentation would be as simple as:
+
+ .. code-block:: console
-Read the Docs is a popular community project, providing a single location for
-all documentation of popular and even more exotic Python modules.
+ $ pydoc time
- `Read the Docs `_
+The above command is essentially equivalent to opening the Python REPL
+and running:
+ .. code-block:: pycon
+ >>> help(time)
diff --git a/docs/intro/duction.rst b/docs/intro/duction.rst
index 7b0cf7dda..16baebc0d 100644
--- a/docs/intro/duction.rst
+++ b/docs/intro/duction.rst
@@ -1,5 +1,10 @@
+
+
+############
Introduction
-============
+############
+
+.. image:: /_static/photos/34725946825_0f85497e60_k_d.jpg
From the `official Python website `_:
@@ -7,30 +12,30 @@ Python is a general-purpose, high-level programming language similar
to Tcl, Perl, Ruby, Scheme, or Java. Some of its main key features
include:
-* very clear, readable syntax
+* **very clear, readable syntax**
Python's philosophy focuses on readability, from code blocks
delineated with significant whitespace to intuitive keywords in
- place of inscrutable punctuation
+ place of inscrutable punctuation.
-* extensive standard libraries and third party modules for virtually
- any task
+* **extensive standard libraries and third party modules for virtually
+ any task**
Python is sometimes described with the words "batteries included"
- for its extensive
+ because of its extensive
`standard library `_, which includes
modules for regular expressions, file IO, fraction handling,
object serialization, and much more.
Additionally, the
- `Python Package Index `_ is available
+ `Python Package Index `_ is available
for users to submit their packages for widespread use, similar to
- Perl's `CPAN `_. There is a thriving community
+ Perl's `CPAN `_. There is a thriving community
of very powerful Python frameworks and tools like
- the `Django `_ web framework and the
+ the `Django `_ web framework and the
`NumPy `_ set of math routines.
-* integration with other systems
+* **integration with other systems**
Python can integrate with `Java libraries `_,
enabling it to be used with the rich Java environment that corporate
@@ -38,13 +43,13 @@ include:
`extended by C or C++ modules `_
when speed is of the essence.
-* ubiquity on computers
+* **ubiquity on computers**
Python is available on Windows, \*nix, and Mac. It runs wherever the
Java virtual machine runs, and the reference implementation CPython
can help bring Python to wherever there is a working C compiler.
-* friendly community
+* **friendly community**
Python has a vibrant and large :ref:`community `
which maintains wikis, conferences, countless repositories,
@@ -54,14 +59,16 @@ include:
.. _about-ref:
+
+****************
About This Guide
-----------------
+****************
Purpose
~~~~~~~
The Hitchhiker's Guide to Python exists to provide both novice and expert
-Python developers a best-practice handbook to the installation, configuration,
+Python developers a best practice handbook for the installation, configuration,
and usage of Python on a daily basis.
@@ -77,12 +84,12 @@ For the Community
All contributions to the Guide are welcome, from Pythonistas of all levels.
If you think there's a gap in what the Guide covers, fork the Guide on
-GitHub and submit a pull request. Contributions are welcome from everyone,
-whether they're an old hand or a first-time Pythonista, and the authors to
-the Guide will gladly help if you have any questions about the
-appropriateness, completeness, or accuracy of a contribution.
-
-To get started working on The Hitchhiker's Guide, see
-the: doc:`/notes/contribute` page.
+GitHub and submit a pull request.
+Contributions are welcome from everyone, whether they're an old hand or a
+first-time Pythonista, and the authors to the Guide will gladly help if you
+have any questions about the appropriateness, completeness, or accuracy of
+a contribution.
+To get started working on The Hitchhiker's Guide,
+see the :doc:`/notes/contribute` page.
diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst
index b412311ab..b0c957398 100644
--- a/docs/intro/learning.rst
+++ b/docs/intro/learning.rst
@@ -1,26 +1,114 @@
+
+
+###############
Learning Python
-===============
+###############
+
+.. image:: /_static/photos/32800783863_11a00db52c_k_d.jpg
+
+********
Beginner
---------
+********
+
+The Python Tutorial
+~~~~~~~~~~~~~~~~~~~~
+
+This is the official tutorial. It covers all the basics, and offers a tour of
+the language and the standard library. Recommended for those who need a
+quick-start guide to the language.
+
+ `The Python Tutorial `_
+
+Real Python
+~~~~~~~~~~~
+
+Real Python is a repository of free and in-depth Python tutorials created by a diverse team of professional Python developers. At Real Python you can learn all things Python from the ground up. Everything from the absolute basics of Python, to web development and web scraping, to data visualization, and beyond.
+
+ `Real Python `_
+
+Python Basics
+~~~~~~~~~~~~~
+
+pythonbasics.org is an introductory tutorial for beginners. The tutorial includes exercises. It covers the basics and there are also in-depth lessons like object oriented programming and regular expressions.
+
+ `Python basics `_
+
+Python for Beginners
+~~~~~~~~~~~~~~~~~~~~
+
+thepythonguru.com is a tutorial focused on beginner programmers. It covers many Python concepts
+in depth. It also teaches you some advanced constructs of Python like lambda expressions and regular expressions.
+And last it finishes off with the tutorial "How to access MySQL db using Python"
+
+ `Python for Beginners `_
Learn Python Interactive Tutorial
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-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
-allows you to go through the lessons without having to install Python locally.
+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 allows you to go through the lessons
+without having to install Python locally.
`Learn Python `_
+Python for You and Me
+~~~~~~~~~~~~~~~~~~~~~
+
+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 `_
+
+Learn Python Step by Step
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Techbeamers.com provides step-by-step tutorials to teach Python. Each tutorial is supplemented with logically added coding snippets and equips with a follow-up quiz on the subject learned. There is a section for `Python interview questions `_ to help job seekers. You can also read essential `Python tips `_ and learn `best coding practices `_ for writing quality code. Here, you'll get the right platform to learn Python quickly.
+
+`Learn Python Basic to Advanced `_
+
+
+Online Python Tutor
+~~~~~~~~~~~~~~~~~~~
+
+Online Python Tutor gives you a visual step-by-step
+representation of how your program runs. Python Tutor
+helps people overcome a fundamental barrier to learning
+programming by understanding what happens as the computer
+executes each line of a program's source code.
+
+ `Online Python Tutor `_
+
+Invent Your Own Computer Games with Python
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This beginner's book is for those with no programming experience at all. Each
+chapter has the source code to a small game, using these example programs
+to demonstrate programming concepts to give the reader an idea of what
+programs "look like".
+
+ `Invent Your Own Computer Games with Python `_
+
+
+Hacking Secret Ciphers with Python
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This book teaches Python programming and basic cryptography for absolute
+beginners. The chapters provide the source code for various ciphers, as well
+as programs that can break them.
+
+ `Hacking Secret Ciphers with Python `_
+
+
Learn Python the Hard Way
~~~~~~~~~~~~~~~~~~~~~~~~~
This is an excellent beginner programmer's guide to Python. It covers "hello
world" from the console to the web.
- `Learn Python the Hard Way `_
+ `Learn Python the Hard Way `_
Crash into Python
@@ -29,7 +117,7 @@ Crash into Python
Also known as *Python for Programmers with 3 Hours*, this guide gives
experienced developers from other languages a crash course on Python.
- `Crash into Python `_
+ `Crash into Python `_
Dive Into Python 3
@@ -39,22 +127,23 @@ Dive Into Python 3 is a good book for those ready to jump in to Python 3. It's
a good read if you are moving from Python 2 to 3 or if you already have some
experience programming in another language.
- `Dive Into Python 3 `_
+ `Dive Into Python 3 `_
+
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
-with plenty of exercises, minimal jargon and a section in each chapter devoted
+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
topics discussed in the book in greater detail by applying those topics to
-real-world examples. Case studies include assignments in GUI and Markov
+real-world examples. Case studies include assignments in GUI programming and Markov
Analysis.
`Think Python `_
@@ -64,38 +153,90 @@ 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.
+approach 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.
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 `_
+ `Python Koans `_
More information about test driven development can be found at these resources:
- `Test Driven Development `_
+ `Test Driven Development `_
+
A Byte of Python
~~~~~~~~~~~~~~~~
-A free introductory book that teaches python at the beginner level, it assumes no
-previous programming experience.
+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 `_
- `A Byte of Python for Python 3.x `_
+ `A Byte of Python for Python 3.x `_
+
+Computer Science Path on Codecademy
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A Codecademy course for the absolute Python beginner. This free and interactive
+course provides and teaches the basics (and beyond) of Python programming while
+testing the user's knowledge in between progress.
+This course also features a built-in interpreter for receiving instant feedback on your learning.
+
+ `Computer Science Path on Codecademy `_
+
+
+Code the blocks
+~~~~~~~~~~~~~~~
+
+*Code the blocks* provides free and interactive Python tutorials for
+beginners. It combines Python programming with a 3D environment where
+you "place blocks" and construct structures. The tutorials teach you
+how to use Python to create progressively more elaborate 3D structures,
+making the process of learning Python fun and engaging.
+
+ `Code the blocks `_
+
+
+************
+Intermediate
+************
+
+Python Tricks: The Book
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Discover Python's best practices with simple examples and start writing even more beautiful + Pythonic code. *Python Tricks: The Book* shows you exactly how.
+
+You’ll master intermediate and advanced-level features in Python with practical examples and a clear narrative.
+
+ `Python Tricks: The Book `_
+
+Effective Python
+~~~~~~~~~~~~~~~~
+This book contains 59 specific ways to improve writing Pythonic code. At 227
+pages, it is a very brief overview of some of the most common adaptations
+programmers need to make to become efficient intermediate level Python
+programmers.
+
+ `Effective Python `_
+
+
+********
Advanced
---------
+********
Pro Python
~~~~~~~~~~
-This book is for intermediate to advanced Python programmers who are looking to understand how
-and why Python works the way it does and how they can take their code to the next level.
+This book is for intermediate to advanced Python programmers who are looking to
+understand how and why Python works the way it does and how they can take their
+code to the next level.
+
+ `Pro Python `_
Expert Python Programming
@@ -104,39 +245,168 @@ Expert Python Programming deals with best practices in programming Python and
is focused on the more advanced crowd.
It starts with topics like decorators (with caching, proxy, and context manager
-case-studies), method resolution order, using super() and meta-programming, and
-general PEP8 best practices.
+case studies), method resolution order, using super() and meta-programming, and
+general :pep:`8` best practices.
It has a detailed, multi-chapter case study on writing and releasing a package
and eventually an application, including a chapter on using zc.buildout. Later
-chapters detail best practices with writing documentation, test-driven
-development, version control, and optimization/profiling.
+chapters detail best practices such as writing documentation, test-driven
+development, version control, optimization, and profiling.
- `Expert Python Programming `_
+ `Expert Python Programming `_
-The Python Tutorial
-~~~~~~~~~~~~~~~~~~~~
-This is the official tutorial, it covers all the basics, and offers a tour of the
-language and the standard library, recommended for those who need a quickstart
-guide to the language.
+A Guide to Python's Magic Methods
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This is a collection of blog posts by Rafe Kettler which explain 'magic methods'
+in Python. Magic methods are surrounded by double underscores (i.e. __init__)
+and can make classes and objects behave in different and magical ways.
- `The Python Tutorial `_
+ `A Guide to Python's Magic Methods `_
+
+.. note:: 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
+****************************
+
+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 the scientific field. In the book,
+examples are chosen from mathematics and the natural sciences.
+
+ `A Primer on Scientific Programming with Python `_
+
+Numerical Methods in Engineering with Python
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Numerical Methods in Engineering with Python, written by Jaan Kiusalaas,
+puts the emphasis on numerical methods and how to implement them in Python.
+
+ `Numerical Methods in Engineering with Python `_
+
+
+********************
+Miscellaneous Topics
+********************
+
+Problem Solving with Algorithms and Data Structures
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Problem Solving with Algorithms and Data Structures covers a range of data
+structures and algorithms. All concepts are illustrated with Python code along
+with interactive samples that can be run directly in the browser.
+
+ `Problem Solving with Algorithms and Data Structures
+ `_
+
+Programming Collective Intelligence
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Programming Collective Intelligence introduces a wide array of basic machine
+learning and data mining methods. The exposition is not very mathematically
+formal, but rather focuses on explaining the underlying intuition and shows
+how to implement the algorithms in Python.
+
+ `Programming Collective Intelligence `_
+
+
+Transforming Code into Beautiful, Idiomatic Python
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Transforming Code into Beautiful, Idiomatic Python is a video by Raymond Hettinger.
+Learn to take better advantage of Python's best features and improve existing code
+through a series of code transformations: "When you see this, do that instead."
+
+ `Transforming Code into Beautiful, Idiomatic Python `_
+
+
+Fullstack Python
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Fullstack Python offers a complete top-to-bottom resource for web development
+using Python.
+
+From setting up the web server, to designing the front-end, choosing a database,
+optimizing/scaling, etc.
+
+As the name suggests, it covers everything you need to build and run a complete
+web app from scratch.
+
+ `Fullstack Python `_
+
+
+PythonistaCafe
+~~~~~~~~~~~~~~
+
+PythonistaCafe is an invite-only, online community of Python and software development enthusiasts helping each other succeed and grow. Think of it as a club of mutual improvement for Pythonistas where a broad range of programming questions, career advice, and other topics are discussed every day.
+
+ `PythonistaCafe `_
+
+
+**********
References
-----------
+**********
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 usage, from its syntax to built-in libraries to advanced topics such
as writing C extensions.
+ `Python in a Nutshell `_
+
The Python Language Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This is Python's reference manual, it covers the syntax and the core semantics of the
-language.
+This is Python's reference manual. It covers the syntax and the core semantics
+of the language.
`The Python Language Reference `_
+
+Python Essential Reference
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Python Essential Reference, written by David Beazley, is the definitive reference
+guide to Python. It concisely explains both the core language and the most essential
+parts of the standard library. It covers Python 3 and 2.6 versions.
+
+ `Python Essential 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 `_
+
+Python Cookbook
+~~~~~~~~~~~~~~~
+
+Python Cookbook, written by David Beazley and Brian K. Jones, is packed with
+practical recipes. This book covers the core Python language as well as tasks
+common to a wide variety of application domains.
+
+ `Python Cookbook `_
+
+Writing Idiomatic Python
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Writing Idiomatic Python, written by Jeff Knupp, contains the most common and
+important Python idioms in a format that maximizes identification and
+understanding. Each idiom is presented as a recommendation of a way to write
+some commonly used piece of code, followed by an explanation of why the idiom
+is important. It also contains two code samples for each idiom: the "Harmful"
+way to write it and the "Idiomatic" way.
+
+ `For Python 2.7.3+ `_
+
+ `For Python 3.3+ `_
diff --git a/docs/intro/news.rst b/docs/intro/news.rst
index 74a5b44ab..d1cda93be 100644
--- a/docs/intro/news.rst
+++ b/docs/intro/news.rst
@@ -1,33 +1,102 @@
+
+
+####
News
-====
+####
+
+.. image:: /_static/photos/33573767786_eececc5d27_k_d.jpg
+
+
+****************
+PyCoder’s Weekly
+****************
+
+PyCoder’s Weekly is a free weekly Python newsletter for Python developers
+by Python developers (Projects, Articles, News, and Jobs).
+
+ `PyCoder’s Weekly `_
+
+***********
+Real Python
+***********
+
+At Real Python you can learn all things Python from the ground up, with weekly free and in-depth tutorials. Everything from the absolute basics of Python, to web development and web scraping, to data visualization, and beyond.
+
+ `Real Python `_
+
+
+*************
Planet Python
-~~~~~~~~~~~~~
+*************
This is an aggregate of Python news from a growing number of developers.
- `Planet Python `_
+ `Planet Python `_
+
+*********
/r/python
-~~~~~~~~~
+*********
/r/python is the Reddit Python community where users contribute and vote on
Python-related news.
- `/r/python `_
+ `/r/python `_
+
+
+*******************
+Talk Python Podcast
+*******************
+
+The #1 Python-focused podcast covering the people and ideas in Python.
-Pycoder's Weekly
-~~~~~~~~~~~~~~~~
+ `Talk Python To Me `_
-Pycoder's Weekly is a free weekly python newsletter for Python developers
-by Python developers (Project, Articles, News, and Jobs).
- `Pycoder's Weekly `_
+********************
+Python Bytes Podcast
+********************
+A short-form Python podcast covering recent developer headlines.
+
+ `Python Bytes `_
+
+
+*************
Python Weekly
-~~~~~~~~~~~~~
+*************
Python Weekly is a free weekly newsletter featuring curated news, articles,
new releases, jobs, etc. related to Python.
- `Python Weekly `_
+ `Python Weekly `_
+
+
+***********
+Python News
+***********
+
+Python News is the news section in the official Python web site
+(www.python.org). It briefly highlights the news from the Python community.
+
+ `Python News `_
+
+
+********************
+Import Python Weekly
+********************
+
+Weekly Python Newsletter containing Python Articles, Projects, Videos, and Tweets
+delivered in your inbox. Keep Your Python Programming Skills Updated.
+
+ `Import Python Weekly Newsletter `_
+
+
+*************************
+Awesome Python Newsletter
+*************************
+
+A weekly overview of the most popular Python news, articles, and packages.
+
+ `Awesome Python Newsletter `_
diff --git a/docs/make.bat b/docs/make.bat
index 39f2a6893..115651a00 100644
--- a/docs/make.bat
+++ b/docs/make.bat
@@ -7,8 +7,10 @@ if "%SPHINXBUILD%" == "" (
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
@@ -28,7 +30,11 @@ if "%1" == "help" (
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
+ echo. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
+ echo. xml to make Docutils-native XML files
+ echo. pseudoxml to make pseudoxml-XML files for display purposes
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
@@ -40,8 +46,34 @@ if "%1" == "clean" (
goto end
)
+
+REM Check if sphinx-build is available and fallback to Python version if any
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 goto sphinx_python
+goto sphinx_ok
+
+:sphinx_python
+
+set SPHINXBUILD=python -m sphinx.__init__
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+:sphinx_ok
+
+
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
@@ -49,6 +81,7 @@ if "%1" == "html" (
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
@@ -56,6 +89,7 @@ if "%1" == "dirhtml" (
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
@@ -63,6 +97,7 @@ if "%1" == "singlehtml" (
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
@@ -70,6 +105,7 @@ if "%1" == "pickle" (
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
@@ -77,6 +113,7 @@ if "%1" == "json" (
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
@@ -85,17 +122,19 @@ if "%1" == "htmlhelp" (
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
- echo.^> qcollectiongenerator %BUILDDIR%\qthelp\osxpython.qhcp
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pythonguide.qhcp
echo.To view the help file:
- echo.^> assistant -collectionFile %BUILDDIR%\qthelp\osxpython.ghc
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pythonguide.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
@@ -103,6 +142,7 @@ if "%1" == "devhelp" (
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
@@ -110,13 +150,35 @@ if "%1" == "epub" (
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
+if "%1" == "latexpdf" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ cd %BUILDDIR%/latex
+ make all-pdf
+ cd %BUILDDIR%/..
+ echo.
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "latexpdfja" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ cd %BUILDDIR%/latex
+ make all-pdf-ja
+ cd %BUILDDIR%/..
+ echo.
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+ goto end
+)
+
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
@@ -124,13 +186,31 @@ if "%1" == "text" (
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
@@ -138,6 +218,7 @@ if "%1" == "changes" (
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
@@ -146,10 +227,27 @@ or in %BUILDDIR%/linkcheck/output.txt.
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
+if "%1" == "xml" (
+ %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The XML files are in %BUILDDIR%/xml.
+ goto end
+)
+
+if "%1" == "pseudoxml" (
+ %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
+ goto end
+)
+
:end
diff --git a/docs/notes/contribute.rst b/docs/notes/contribute.rst
index 0d709f29f..b6c72bb4f 100644
--- a/docs/notes/contribute.rst
+++ b/docs/notes/contribute.rst
@@ -1,5 +1,8 @@
+##########
Contribute
-~~~~~~~~~~
+##########
+
+.. image:: /_static/photos/33573769116_49c1ef51e7_k_d.jpg
Python-guide is under active development, and contributors are welcome.
@@ -8,20 +11,24 @@ issue on GitHub_. To submit patches, please send a pull request on GitHub_.
Once your changes get merged back in, you'll automatically be added to the
`Contributors List `_.
+
+***********
Style Guide
------------
+***********
For all contributions, please follow the :ref:`guide-style-guide`.
.. _todo-list-ref:
+
+*********
Todo List
----------
+*********
If you'd like to contribute, there's plenty to do. Here's a short todo_ list.
.. include:: ../../TODO.rst
-.. _GitHub: http://github.com/kennethreitz/python-guide/
+.. _GitHub: https://github.com/kennethreitz/python-guide/
.. _todo: https://github.com/kennethreitz/python-guide/blob/master/TODO.rst
diff --git a/docs/notes/license.rst b/docs/notes/license.rst
index d26b3c78c..1dd3d340a 100644
--- a/docs/notes/license.rst
+++ b/docs/notes/license.rst
@@ -1,4 +1,7 @@
+#######
License
--------
+#######
-.. todo:: Determine License
\ No newline at end of file
+.. image:: /_static/photos/32800805573_568d6b72fd_k_d.jpg
+
+The Guide is licensed under the `Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported license `_.
diff --git a/docs/notes/styleguide.rst b/docs/notes/styleguide.rst
index 958382c18..5a715332e 100644
--- a/docs/notes/styleguide.rst
+++ b/docs/notes/styleguide.rst
@@ -1,8 +1,10 @@
.. _guide-style-guide:
-=====================
+#####################
The Guide Style Guide
-=====================
+#####################
+
+.. image:: /_static/photos/33573755856_7f43d43adf_k_d.jpg
As with all documentation, having a consistent format helps make the
document more understandable. In order to make The Guide easier to digest,
@@ -17,8 +19,10 @@ The Guide is written as :ref:`restructuredtext-ref`.
.. note:: On any page of the rendered HTML you can click "Show Source" to
see how authors have styled the page.
+
+*********
Relevancy
----------
+*********
Strive to keep any contributions relevant to the :ref:`purpose of The Guide
`.
@@ -27,63 +31,92 @@ Strive to keep any contributions relevant to the :ref:`purpose of The Guide
relate to Python development.
* Prefer to link to other sources if the information is already out there.
Be sure to describe what and why you are linking.
-* `Cite `_
+* `Cite `_
references where needed.
* If a subject isn't directly relevant to Python, but useful in conjunction
- with Python (ex: Git, Github, Databases), reference by linking to useful
- resources and describe why it's useful to Python.
+ with Python (e.g., Git, GitHub, Databases), reference by linking to useful
+ resources, and describe why it's useful to Python.
* When in doubt, ask.
+
+********
Headings
---------
+********
Use the following styles for headings.
-Chapter title::
+Chapter title:
+
+.. code-block:: rest
#########
Chapter 1
#########
-Page title::
+Page title:
- ===================
+.. code-block:: rest
+
+ *******************
Time is an Illusion
- ===================
+ *******************
-Section headings::
+Section headings:
+
+.. code-block:: rest
Lunchtime Doubly So
- -------------------
+ ===================
-Sub section headings::
+Sub section headings:
+
+.. code-block:: rest
Very Deep
- ~~~~~~~~~
+ ---------
+
+*****
Prose
------
+*****
Wrap text lines at 78 characters. Where necessary, lines may exceed 78
characters, especially if wrapping would make the source text more difficult
to read.
+Use Standard American English, not British English.
+
+Use of the `serial comma `_
+(also known as the Oxford comma) is 100% non-optional. Any attempt to
+submit content with a missing serial comma will result in permanent banishment
+from this project, due to complete and total lack of taste.
+
+Banishment? Is this a joke? Hopefully we will never have to find out.
+
+*************
Code Examples
--------------
+*************
Wrap all code examples at 70 characters to avoid horizontal scrollbars.
-Command line examples::
+Command line examples:
+
+.. code-block:: rest
.. code-block:: console
$ run command --help
$ ls ..
-Be sure to include the ``$`` prefix before each line.
+Be sure to include the ``$`` prefix before each line for Unix console examples.
+
+For Windows console examples, use ``doscon`` or ``powershell`` instead of
+``console``, and omit the ``$`` prefix.
-Python interpreter examples::
+Python interpreter examples:
+
+.. code-block:: rest
Label the example::
@@ -91,7 +124,9 @@ Python interpreter examples::
>>> import this
-Python examples::
+Python examples:
+
+.. code-block:: rest
Descriptive title::
@@ -100,65 +135,82 @@ Python examples::
def get_answer():
return 42
+
+******************
Externally Linking
-------------------
+******************
+
+* Prefer labels for well known subjects (e.g. proper nouns) when linking:
-* Prefer labels for well known subjects (ex: proper nouns) when linking::
+ .. code-block:: rest
- Sphinx_ is used to document Python.
+ Sphinx_ is used to document Python.
- .. _Sphinx: http://sphinx.pocoo.org
+ .. _Sphinx: https://www.sphinx-doc.org
* Prefer to use descriptive labels with inline links instead of leaving bare
- links::
+ links:
+
+ .. code-block:: rest
- Read the `Sphinx Tutorial `_
+ Read the `Sphinx Tutorial `_
-* Avoid using labels such as "click here", "this", etc. preferring
+* Avoid using labels such as "click here", "this", etc., preferring
descriptive labels (SEO worthy) instead.
+
+********************************
Linking to Sections in The Guide
---------------------------------
+********************************
To cross-reference other parts of this documentation, use the `:ref:
-`_
+`_
keyword and labels.
-To make reference labels more clear and unique, always add a ``-ref`` suffix::
+To make reference labels more clear and unique, always add a ``-ref`` suffix:
+
+.. code-block:: rest
.. _some-section-ref:
Some Section
------------
+
+******************
Notes and Warnings
-------------------
+******************
Make use of the appropriate `admonitions directives
-`_ when making notes.
+`_ when making notes.
+
+Notes:
-Notes::
+.. code-block:: rest
.. note::
The Hitchhiker’s Guide to the Galaxy has a few things to say
on the subject of towels. A towel, it says, is about the most
massively useful thing an interstellar hitch hiker can have.
-Warnings::
+Warnings:
+
+.. code-block:: rest
.. warning:: DON'T PANIC
+
+*****
TODOs
------
+*****
Please mark any incomplete areas of The Guide with a `todo directive
-`_. To
+`_. To
avoid cluttering the :ref:`todo-list-ref`, use a single ``todo`` for stub
documents or large incomplete sections.
-::
+.. code-block:: rest
.. todo::
Learn the Ultimate Answer to the Ultimate Question
of Life, The Universe, and Everything
-
diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst
index 481b3410a..f6433c213 100644
--- a/docs/scenarios/admin.rst
+++ b/docs/scenarios/admin.rst
@@ -1,12 +1,18 @@
+
+######################
Systems Administration
-======================
+######################
+
+.. image:: /_static/photos/34435690580_3afec7d4cd_k_d.jpg
+
+******
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:
@@ -17,11 +23,11 @@ Install Fabric:
The following code will create two tasks that we can use: ``memory_usage`` and
``deploy``. The former will output the memory usage on each machine. The
-latter will ssh into each server, cd to our project directory, activate the
+latter will SSH into each server, cd to our project directory, activate the
virtual environment, pull the newest codebase, and restart the application
server.
-::
+.. code-block:: python
from fabric.api import cd, env, prefix, run, task
@@ -38,8 +44,8 @@ server.
run('git pull')
run('touch app.wsgi')
-With the previous code saved in a file named fabfile.py, we can check memory
-usage with:
+With the previous code saved in a file named :file:`fabfile.py`, we can check
+memory usage with:
.. code-block:: console
@@ -69,22 +75,25 @@ programs, and host grouping.
`Fabric Documentation `_
+
+****
Salt
-----
+****
-`Salt `_ is an open source infrastructure management tool.
-It supports remote command execution from a central point (master host) to multiple
-hosts (minions). It also supports system states which can be used to configure
-multiple servers using simple template files.
+`Salt `_ is an open source infrastructure management
+tool. It supports remote command execution from a central point (master host)
+to multiple 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
$ pip install salt
-After configuring a master server and any number of minion hosts, we can run arbitrary
-shell commands or use pre-built modules of complex commands on our minions.
+After configuring a master server and any number of minion hosts, we can run
+arbitrary shell commands or use pre-built modules of complex commands on our
+minions.
The following command lists all available minion hosts, using the ping module.
@@ -92,21 +101,24 @@ The following command lists all available minion hosts, using the ping module.
$ salt '*' test.ping
-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.
+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.
-The following command lists all available minions running CentOS using the grains system:
+The following command lists all available minions running CentOS using the
+grains system:
.. code-block:: console
$ salt -G 'os:CentOS' test.ping
-Salt also provides a state system. States can be used to configure the minion hosts.
+Salt also provides a state system. States can be used to configure the minion
+hosts.
-For example, when a minion host is ordered to read the following state file, it will install
-and start the Apache server:
+For example, when a minion host is ordered to read the following state file,
+it will install and start the Apache server:
.. code-block:: yaml
@@ -115,35 +127,271 @@ and start the Apache server:
- installed
service:
- running
+ - enable: True
+ - require:
+ - pkg: apache
+
+State files can be written using YAML, the Jinja2 template system, or pure Python.
+
+ `Salt Documentation `_
+
+
+******
+Psutil
+******
+
+`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
+tests (net, CPU) fail, it will send an email.
+
+.. code-block:: python
+
+ # Functions to get system values:
+ from psutil import cpu_percent, net_io_counters
+ # Functions to take a break:
+ from time import sleep
+ # Package for email services:
+ import smtplib
+ import string
+ MAX_NET_USAGE = 400000 # bytes per seconds
+ MAX_ATTACKS = 4
+ attack = 0
+ while attack <= MAX_ATTACKS:
+ sleep(4)
+
+ # Check the net usage wit named tuples
+ neti1 = net_io_counters().bytes_recv
+ neto1 = net_io_counters().bytes_sent
+ sleep(1)
+ neti2 = net_io_counters().bytes_recv
+ neto2 = net_io_counters().bytes_sent
+
+ # Calculate the bytes per second
+ net = ((neti2+neto2) - (neti1+neto1))/2
+
+ # Check the net and cpu usage
+ if (net > MAX_NET_USAGE) or (cpu_percent(interval = 1) > 70):
+ attack+=1
+ elif attack > 1:
+ attack-=1
+
+ # Write a very important email if attack is higher than 4
+ TO = "you@your_email.com"
+ FROM = "webmaster@your_domain.com"
+ SUBJECT = "Your domain is out of system resources!"
+ text = "Go and fix your server!"
+ string="\r\n"
+ BODY = string.join(("From: %s" %FROM,"To: %s" %TO,
+ "Subject: %s" %SUBJECT, "",text))
+ server = smtplib.SMTP('127.0.0.1')
+ server.sendmail(FROM, [TO], BODY)
+ server.quit()
+
+
+A full terminal application like a widely extended top is `Glance `_, which is based on psutil and has the ability for client-server monitoring.
+
+*******
+Ansible
+*******
+
+`Ansible `_ is an open source system automation tool.
+Its biggest advantage over Puppet or Chef is that it does not require an agent on
+the client machine. Playbooks are Ansible’s configuration, deployment, and
+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:
+
+.. code-block:: console
+
+ $ pip install ansible
+
+Ansible requires an inventory file that describes the hosts to which it has
+access. Below is an example of a host and playbook that will ping all the
+hosts in the inventory file.
+
+Here is an example inventory file:
+:file:`hosts.yml`
+
+.. code-block:: yaml
+
+ [server_name]
+ 127.0.0.1
+
+Here is an example playbook:
+:file:`ping.yml`
+
+.. code-block:: yaml
-State files can be written using YAML, the Jinja2 template system or pure python.
+ ---
+ - hosts: all
- `Salt Documentation `_
+ tasks:
+ - name: ping
+ action: ping
+To run the playbook:
+
+.. code-block:: console
+
+ $ ansible-playbook ping.yml -i hosts.yml --ask-pass
+
+The Ansible playbook will ping all of the servers in the :file:`hosts.yml` file.
+You can also select groups of servers using Ansible. For more information
+about Ansible, read the `Ansible Docs `_.
+
+`An Ansible tutorial `_ is also a
+great and detailed introduction to getting started with Ansible.
+
+
+****
Chef
-----
+****
+
+`Chef `_ is a systems and cloud infrastructure automation
+framework that makes it easy to deploy servers and applications to any physical,
+virtual, or cloud location. In case this is your choice for configuration management,
+you will primarily use Ruby to write your infrastructure code.
+
+Chef clients run on every server that is part of your infrastructure and these regularly
+check with your Chef server to ensure your system is always aligned and represents the
+desired state. Since each individual server has its own distinct Chef client, each server
+configures itself and this distributed approach makes Chef a scalable automation platform.
+
+Chef works by using custom recipes (configuration elements), implemented in cookbooks. Cookbooks, which are basically
+packages for infrastructure choices, are usually stored in your Chef server.
+Read the `DigitalOcean tutorial series
+`_
+on Chef to learn how to create a simple Chef Server.
+
+To create a simple cookbook the `knife `_ command is used:
+
+.. code-block:: console
+
+ knife cookbook create cookbook_name
-.. todo:: Write about Chef
+`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 infrastructure configuration needs can be
+found on the `Chef Supermarket `_.
- `Chef Documentation
- `_
+- `Chef Documentation `_
+
+******
Puppet
-------
+******
-.. todo:: Write about Puppet
+`Puppet `_ is IT Automation and configuration management
+software from Puppet Labs that allows System Administrators to define the state
+of their IT Infrastructure, thereby providing an elegant way to manage their
+fleet of physical and virtual machines.
- `Puppet Labs Documentation `_
+Puppet is available both as an Open Source and an Enterprise variant. Modules
+are small, shareable units of code written to automate or define the state of a
+system. `Puppet Forge `_ is a repository for
+modules written by the community for Open Source and Enterprise Puppet.
-Blueprint
----------
+Puppet Agents are installed on nodes whose state needs to be monitored or
+changed. A designated server known as the Puppet Master is responsible for
+orchestrating the agent nodes.
-.. todo:: Write about Blueprint
+Agent nodes send basic facts about the system such as the operating system,
+kernel, architecture, IP address, hostname, etc. to the Puppet Master.
+The Puppet Master then compiles a catalog with information provided by the
+agents on how each node should be configured and sends it to the agent. The
+agent enforces the change as prescribed in the catalog and sends a report back
+to the Puppet Master.
-Buildout
---------
+Facter is an interesting tool that ships with Puppet that pulls basic facts
+about the system. These facts can be referenced as a variable while writing
+your Puppet modules.
+
+.. code-block:: console
+
+ $ facter kernel
+ Linux
+.. code-block:: console
+
+ $ facter operatingsystem
+ Ubuntu
+
+Writing Modules in Puppet is pretty straight forward. Puppet Manifests together
+form Puppet Modules. Puppet manifests end with an extension of ``.pp``.
+Here is an example of 'Hello World' in Puppet.
+
+.. code-block:: puppet
+
+ notify { 'This message is getting logged into the agent node':
+
+ #As nothing is specified in the body the resource title
+ #the notification message by default.
+ }
+
+Here is another example with system based logic. Note how the operating system
+fact is being used as a variable prepended with the ``$`` sign. Similarly, this
+holds true for other facts such as hostname which can be referenced by
+``$hostname``.
-.. todo:: Write about Buildout
+.. code-block:: puppet
- `Buildout Website `_
+ notify{ 'Mac Warning':
+ message => $operatingsystem ? {
+ 'Darwin' => 'This seems to be a Mac.',
+ default => 'I am a PC.',
+ },
+ }
+There are several resource types for Puppet but the package-file-service
+paradigm is all you need for undertaking the majority of the configuration
+management. The following Puppet code makes sure that the OpenSSH-Server
+package is installed in a system and the sshd service is notified to restart
+every time the sshd configuration file is changed.
+
+.. code-block:: puppet
+
+ package { 'openssh-server':
+ ensure => installed,
+ }
+
+ file { '/etc/ssh/sshd_config':
+ source => 'puppet:///modules/sshd/sshd_config',
+ owner => 'root',
+ group => 'root',
+ mode => '640',
+ notify => Service['sshd'], # sshd will restart
+ # whenever you edit this
+ # file
+ require => Package['openssh-server'],
+
+ }
+
+ service { 'sshd':
+ ensure => running,
+ enable => true,
+ hasstatus => true,
+ hasrestart=> true,
+ }
+
+For more information, refer to the `Puppet Labs Documentation `_
+
+
+*********
+Blueprint
+*********
+
+.. todo:: Write about Blueprint
+
+
+********
+Buildout
+********
+
+`Buildout `_ is an open source software build tool.
+Buildout is created using the Python programming language. It implements a
+principle of separation of configuration from the scripts that do the setting
+up. 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.
diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index 3a80c70b3..4296679c7 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -1,12 +1,20 @@
+
+######################
Continuous Integration
-======================
+######################
+
+.. image:: /_static/photos/33907150594_9abba7ad0a_k_d.jpg
+
+.. note::
+ For advice on writing your tests, see :doc:`/writing/tests`.
+****
Why?
-----
+****
Martin Fowler, who first wrote about `Continuous Integration `_
-(short: CI) together with Kent Beck, describes the CI as follows:
+(short: CI) together with Kent Beck, describes CI as follows:
Continuous Integration is a software development practice where members of
a team integrate their work frequently, usually each person integrates at
@@ -16,30 +24,28 @@ Martin Fowler, who first wrote about `Continuous Integration `_ is an extensible continuous integration
-engine. Use it.
+*******
+Jenkins
+*******
+`Jenkins CI `_ is an extensible Continuous Integration engine. Use it.
+********
Buildbot
---------
-`Buildbot `_ is a Python system to
-automate the compile/test cycle to validate code changes.
-
+********
-Mule?
------
+`Buildbot `_ is a Python system to
+automate the compile/test cycle to validate code changes.
-.. todo:: Write about Mule
+***
Tox
----
+***
-`tox `_ is an automation tool providing
-packaging, testing and deployment of Python software right from the console or
+`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:
@@ -47,29 +53,30 @@ 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
- and merging CI and shell-based testing.
+* Acting as a front-end to Continuous Integration servers, reducing boilerplate
+ and merging CI and shell-based testing
+*********
Travis-CI
----------
-`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
-hosting your code on Github, travis-ci is a great and easy way to get started with
-Continuous Integration.
+*********
+
+`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 hosting your code on GitHub, Travis-CI is a great
+and easy way to get started with Continuous Integration.
-In order to get started, add a ``.travis.yml`` file to your repository with this
-example content::
+In order to get started, add a :file:`.travis.yml` file to your repository with
+this example content::
language: python
python:
- - "2.5"
- "2.6"
- "2.7"
- - "3.1"
- "3.2"
+ - "3.3"
# command to install dependencies
script: python tests/test_all_of_the_units.py
branches:
@@ -77,12 +84,13 @@ example content::
- master
-This will get your project tested on all the listed Python versions by running the given
-script and only build the master branch. There are a lot more options you can enable, like
-notifications, before and after steps and much more. The
-`travis-ci docs `_ explain all of those and are very
-thorough.
+This will get your project tested on all the listed Python versions by
+running the given script, and will only build the ``master`` branch. There are a
+lot more options you can enable, like notifications, before and after steps,
+and much more. The `Travis-CI docs `_
+explain all of these options, and are very 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.
+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 you're ready to go. From now on, your project's tests
+will be run on every push to GitHub.
diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst
index 2416125f7..59f311e83 100644
--- a/docs/scenarios/cli.rst
+++ b/docs/scenarios/cli.rst
@@ -1,14 +1,91 @@
-Command Line Applications
-=========================
-.. todo:: Explain "Command Line Applications"
+#########################
+Command-line Applications
+#########################
-Clint
------
+.. image:: /_static/photos/34435690330_11930b5987_k_d.jpg
-.. todo:: Write about Clint
+Command-line applications, also referred to as `Console Applications
+`_, are computer programs
+designed to be used from a text interface, such as a `shell
+`_. Command-line applications
+usually accept various inputs as arguments, often referred to as parameters or
+sub-commands, as well as options, often referred to as flags or switches.
+Some popular command-line applications include:
+
+* `grep `_ - A plain-text data search utility
+* `curl `_ - A tool for data transfer with URL syntax
+* `httpie `_ - A command-line HTTP
+ client, a user-friendly cURL replacement
+* `Git `_ - A distributed version control system
+* `Mercurial `_ - A distributed version control
+ system primarily written in Python
+
+
+*****
+Click
+*****
+
+`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.
+
+
+******
docopt
-------
+******
+
+`docopt `_ is a lightweight, highly Pythonic package that
+allows creating command-line interfaces easily and intuitively, by parsing
+POSIX-style usage instructions.
+
+
+****
+Plac
+****
+
+`Plac `_ is a simple wrapper
+over the Python standard library `argparse `_,
+which hides most of its complexity by using a declarative interface: the
+argument parser is inferred rather than written down imperatively. This
+module targets unsophisticated users, programmers, sysadmins,
+scientists, and in general people writing throw-away scripts for themselves,
+who choose to create a command-line interface because it is quick and simple.
+
+
+*****
+Cliff
+*****
+
+`Cliff `_ is a framework for
+building command-line programs. It uses setuptools entry points to provide
+subcommands, output formatters, and other extensions. The framework is meant
+to be used to create multi-level commands such as ``svn`` 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 its use
+cases span from the simplicity of a micro-framework to the complexity of a
+mega-framework.
+
+
+***********
+Python Fire
+***********
-`docopt `_ is a lightweight, highly Pythonic package that allows creating command line interfaces easily and intuitively, by parsing POSIX-style usage instructions.
+`Python Fire `_ is a library for
+automatically generating command-line interfaces from absolutely any Python
+object. It can help debug Python code more easily from the command line,
+create CLI interfaces to existing code, allow you to interactively explore
+code in a REPL, and simplify transitioning between Python and Bash (or any
+other shell).
diff --git a/docs/scenarios/clibs.rst b/docs/scenarios/clibs.rst
new file mode 100644
index 000000000..13c9e4802
--- /dev/null
+++ b/docs/scenarios/clibs.rst
@@ -0,0 +1,141 @@
+
+################################
+Interfacing with C/C++ Libraries
+################################
+
+.. image:: /_static/photos/34725951345_c8f5959a2e_k_d.jpg
+
+
+****************************
+C Foreign Function Interface
+****************************
+
+`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
+exposing the same functionality as `LoadLibrary `_ or `dlopen `_), and an API mode,
+which allows you to build C extension modules.
+
+ABI Interaction
+~~~~~~~~~~~~~~~
+
+.. code-block:: python
+ :linenos:
+
+ from cffi import FFI
+ ffi = FFI()
+ ffi.cdef("size_t strlen(const char*);")
+ clib = ffi.dlopen(None)
+ length = clib.strlen("String to be evaluated.")
+ # prints: 23
+ print("{}".format(length))
+
+
+******
+ctypes
+******
+
+`ctypes `_ is the de facto standard
+library for interfacing with C/C++ from CPython, and it provides not only
+full access to the native C interface of most major operating systems (e.g.,
+kernel32 on Windows, or libc on \*nix), but also provides support for loading
+and interfacing with dynamic libraries, such as DLLs or shared objects, at
+runtime. It brings along with it a whole host of types for interacting
+with system APIs, and allows you to rather easily define your own complex
+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 usable by a pure C/C++ method.
+
+Struct Equivalents
+~~~~~~~~~~~~~~~~~~
+
+:file:`MyStruct.h`
+
+.. code-block:: c
+ :linenos:
+
+ struct my_struct {
+ int a;
+ int b;
+ };
+
+:file:`MyStruct.py`
+
+.. code-block:: python
+ :linenos:
+
+ import ctypes
+ class my_struct(ctypes.Structure):
+ _fields_ = [("a", c_int),
+ ("b", c_int)]
+
+
+****
+SWIG
+****
+
+`SWIG `_, though not strictly Python focused (it supports a
+large number of scripting languages), is a tool for generating bindings for
+interpreted languages from C/C++ header files. It is extremely simple to use:
+the consumer simply needs to define an interface file (detailed in the
+tutorial and documentations), include the requisite C/C++ headers, and run
+the build tool against them. While it does have some limits (it currently
+seems to have issues with a small subset of newer C++ features, and getting
+template-heavy code to work can be a bit verbose), it provides a great deal
+of power and exposes lots of features to Python with little effort.
+Additionally, you can easily extend the bindings SWIG creates (in the
+interface file) to overload operators and built-in methods, effectively re-
+cast C++ exceptions to be catchable by Python, etc.
+
+Example: Overloading __repr__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:file:`MyClass.h`
+
+.. code-block:: c++
+ :linenos:
+
+ #include
+ class MyClass {
+ private:
+ std::string name;
+ public:
+ std::string getName();
+ };
+
+
+:file:`myclass.i`
+
+.. code-block:: idl
+ :linenos:
+
+ %include "string.i"
+
+ %module myclass
+ %{
+ #include
+ #include "MyClass.h"
+ %}
+
+ %extend MyClass {
+ std::string __repr__()
+ {
+ return $self->getName();
+ }
+ }
+
+ %include "MyClass.h"
+
+
+************
+Boost.Python
+************
+
+`Boost.Python `_
+requires a bit more manual work to expose C++ object functionality, but
+it is capable of providing all the same features SWIG does and then some,
+to include providing wrappers to access PyObjects in C++, extracting SWIG
+wrapper objects, and even embedding bits of Python into your C++ code.
diff --git a/docs/scenarios/client.rst b/docs/scenarios/client.rst
index 8a4fdde4b..c2d5c289b 100644
--- a/docs/scenarios/client.rst
+++ b/docs/scenarios/client.rst
@@ -1,10 +1,14 @@
+
+####################
Network Applications
-====================
+####################
+.. image:: /_static/photos/34364815780_bea6614025_k_d.jpg
+****
HTTP
-::::
+****
The Hypertext Transfer Protocol (HTTP) is an application protocol for
distributed, collaborative, hypermedia information systems. HTTP is the
@@ -24,13 +28,14 @@ your URLs, or to form-encode your POST data. Keep-alive and HTTP connection
pooling are 100% automatic, powered by urllib3, which is embedded within
Requests.
-- `Documentation `_
-- `PyPi `_
+- `Documentation `_
+- `PyPi `_
- `GitHub `_
+*******************
Distributed Systems
-::::::::::::::::::::
+*******************
ZeroMQ
@@ -45,5 +50,11 @@ library is designed to have a familiar socket-style API.
RabbitMQ
--------
-.. todo:: Write about RabbitMQ
+RabbitMQ is an open source message broker software that implements the Advanced
+Message Queuing Protocol (AMQP). The RabbitMQ server is written in the Erlang
+programming language and is built on the Open Telecom Platform framework for
+clustering and failover. Client libraries to interface with the broker are
+available for all major programming languages.
+- `Homepage `_
+- `GitHub Organization `_
diff --git a/docs/scenarios/crypto.rst b/docs/scenarios/crypto.rst
new file mode 100644
index 000000000..262337204
--- /dev/null
+++ b/docs/scenarios/crypto.rst
@@ -0,0 +1,91 @@
+
+############
+Cryptography
+############
+
+.. image:: /_static/photos/33907152824_bf91078cc1_k_d.jpg
+
+
+************
+cryptography
+************
+
+`cryptography `_ is an actively developed
+library that provides cryptographic recipes and primitives. It supports
+Python 2.6-2.7, Python 3.3+, and PyPy.
+
+
+cryptography is divided into two layers of recipes and hazardous materials
+(hazmat). The recipes layer provides a simple API for proper symmetric
+encryption and the hazmat layer provides low-level cryptographic primitives.
+
+
+
+Installation
+~~~~~~~~~~~~
+
+.. code-block:: console
+
+ $ pip install cryptography
+
+Example
+~~~~~~~
+
+Example code using high level symmetric encryption recipe:
+
+.. code-block:: python
+
+ from cryptography.fernet import Fernet
+ key = Fernet.generate_key()
+ cipher_suite = Fernet(key)
+ cipher_text = cipher_suite.encrypt(b"A really secret message. Not for prying eyes.")
+ plain_text = cipher_suite.decrypt(cipher_text)
+
+
+**************
+GPGME bindings
+**************
+
+The `GPGME Python bindings `_ provide Pythonic access to `GPG Made Easy `_, a C API for the entire GNU Privacy Guard suite of projects, including GPG, libgcrypt, and gpgsm (the S/MIME engine). It supports Python 2.6, 2.7, 3.4, and above. Depends on the SWIG C interface for Python as well as the GnuPG software and libraries.
+
+
+A more comprehensive `GPGME Python Bindings HOWTO `_ is available with the source, and an HTML version is available `at http://files.au.adversary.org `_. Python 3 sample scripts from the examples in the HOWTO are also provided with the source and are accessible `at gnupg.org `_.
+
+Available under the same terms as the rest of the GnuPG Project: GPLv2 and LGPLv2.1, both with the "or any later version" clause.
+
+Installation
+~~~~~~~~~~~~
+
+Included by default when compiling GPGME if the configure script locates a supported python version (which it will if it's in $PATH during configuration).
+
+Example
+~~~~~~~
+
+.. code-block:: python3
+
+ import gpg
+
+ # Encryption to public key specified in rkey.
+ a_key = input("Enter the fingerprint or key ID to encrypt to: ")
+ filename = input("Enter the filename to encrypt: ")
+ with open(filename, "rb") as afile:
+ text = afile.read()
+ c = gpg.core.Context(armor=True)
+ rkey = list(c.keylist(pattern=a_key, secret=False))
+ ciphertext, result, sign_result = c.encrypt(text, recipients=rkey,
+ always_trust=True,
+ add_encrypt_to=True)
+ with open("{0}.asc".format(filename), "wb") as bfile:
+ bfile.write(ciphertext)
+ # Decryption with corresponding secret key
+ # invokes gpg-agent and pinentry.
+ with open("{0}.asc".format(filename), "rb") as cfile:
+ plaintext, result, verify_result = gpg.Context().decrypt(cfile)
+ with open("new-{0}".format(filename), "wb") as dfile:
+ dfile.write(plaintext)
+ # Matching the data.
+ # Also running a diff on filename and the new filename should match.
+ if text == plaintext:
+ print("Hang on ... did you say *all* of GnuPG? Yep.")
+ else:
+ pass
diff --git a/docs/scenarios/db.rst b/docs/scenarios/db.rst
index d3c398f82..21217477a 100644
--- a/docs/scenarios/db.rst
+++ b/docs/scenarios/db.rst
@@ -1,35 +1,118 @@
+
+#########
Databases
-=========
+#########
+
+.. image:: /_static/photos/33907152464_a99fdcc8de_k_d.jpg
+
+******
DB-API
-------
+******
The Python Database API (DB-API) defines a standard interface for Python
-database access modules. It's documented in `PEP 249 `_.
-Nearly all Python database modules such as `sqlite3`, `psycopg` and
+database access modules. It's documented in :pep:`249`.
+Nearly all Python database modules such as `sqlite3`, `psycopg`, and
`mysql-python` conform to this interface.
Tutorials that explain how to work with modules that conform to this interface can be found
`here `__ and
-`here `__.
+`here `__.
+
+**********
SQLAlchemy
-----------
+**********
`SQLAlchemy `_ is a commonly used database toolkit.
Unlike many database libraries it not only provides an ORM layer but also a
generalized API for writing database-agnostic code without SQL.
-::
+.. code-block:: console
+
+ $ pip install sqlalchemy
+
+
+*******
+Records
+*******
+
+`Records `_ is minimalist SQL library,
+designed for sending raw SQL queries to various databases. Data can be used
+programmatically or exported to a number of useful data formats.
+
+.. code-block:: console
+
+ $ pip install records
+
+Also included is a command-line tool for exporting SQL data.
+
+
+******
+PugSQL
+******
+
+`PugSQL `_ is a simple Python interface for organizing
+and using parameterized, handwritten SQL. It is an anti-ORM that is
+philosophically lo-fi, but it still presents a clean interface in Python.
- pip install sqlalchemy
+.. code-block:: console
+ $ pip install pugsql
+
+
+**********
Django ORM
-----------
+**********
-The Django ORM is the interface used by `Django `_
+The Django ORM is the interface used by `Django `_
to provide database access.
-It's based on the idea of `models `_, an abstraction that makes it easier to
-manipulate data in Python.
+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 `__.
+
+
+******
+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 PostgreSQL by default. The
+`model layer `_
+is similar to that of the Django ORM and it has
+`SQL-like methods `_
+to query data. While SQLite, MySQL, and PostgreSQL are supported out-of-the-box,
+there is a `collection of add-ons `_
+available.
+
+
+*******
+PonyORM
+*******
+
+`PonyORM `_ is an ORM that takes a different approach to
+querying the database. Instead of writing an SQL-like language or boolean
+expressions, Python's generator syntax is used. There's also a graphical
+schema editor that can generate PonyORM entities for you. It supports Python
+2.6+ and Python 3.3+ and can connect to SQLite, MySQL, PostgreSQL, and Oracle.
+
+
+*********
+SQLObject
+*********
+
+`SQLObject `_ is yet another ORM. It supports a wide
+variety of databases: common database systems like MySQL, PostgreSQL, and SQLite and
+more exotic systems like SAP DB, SyBase, and Microsoft SQL Server. It only supports Python 2
+from Python 2.6 upwards.
+.. There's no official information on this on their page; this information was gathered by looking at their source code.
diff --git a/docs/scenarios/gui.rst b/docs/scenarios/gui.rst
index 7194f57bd..3ad0af364 100644
--- a/docs/scenarios/gui.rst
+++ b/docs/scenarios/gui.rst
@@ -1,78 +1,185 @@
+
+################
GUI Applications
-================
+################
+.. image:: /_static/photos/33907143624_cd621b535c_k_d.jpg
+
+
+Alphabetical list of GUI Applications.
+
+
+*******
+Camelot
+*******
+
+`Camelot `_ provides components for building
+applications on top of Python, SQLAlchemy, and Qt. It is inspired by the Django
+admin interface.
+
+The main resource for information is the website:
+http://www.python-camelot.com
+and the mailing list https://groups.google.com/forum/#!forum/project-camelot.
+
+
+*****
+Cocoa
+*****
+
+.. note:: The Cocoa framework is only available on OS X. Don't pick this if you're writing a cross-platform application!
+
+
+***
+GTk
+***
+
+.. note:: PyGTK provides Python bindings for the GTK+ toolkit. However, it has been superseded by PyGObject. PyGTK should not be used for new projects and existing projects should be ported 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 `_.
+
+`API Reference `_
+
+
+****
+Kivy
+****
+
+`Kivy `_ is a Python library for development of multi-touch
+enabled media rich applications. The aim is to allow for quick and easy
+interaction design and rapid prototyping, while making your code reusable and
+deployable.
+
+Kivy is written in Python, based on OpenGL, and supports different input devices
+such as: Mouse, Dual Mouse, TUIO, WiiMote, WM_TOUCH, HIDtouch, Apple's products,
+and so on.
+
+Kivy is actively being developed by a community and is free to use. It operates
+on all major platforms (Linux, OS X, Windows, Android).
+
+The main resource for information is the website: http://kivy.org
+
+
+******
+PyObjC
+******
+
+.. note:: Only available on OSÂ X. Don't pick this if you're writing a cross-platform application.
-Qt
---
-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
-~~~~~~
+******
+
PySide is a Python binding of the cross-platform GUI toolkit Qt.
+The package name depends on the major Qt version (`PySide` for Qt4,
+`PySide2` for Qt5, and `PySide6` for Qt6).
+This set of bindings is developed by `The Qt Company `_.
+
+.. code-block:: console
+
+ $ pip install pyside6
-http://developer.qt.nokia.com/wiki/PySideDownloads/
+https://pyside.org
+
+****
PyQt
-~~~~
+****
+
.. note:: If your software does not fully comply with the GPL you will need a commercial license!
+PyQt provides Python bindings for the Qt Framework (see below).
+
http://www.riverbankcomputing.co.uk/software/pyqt/download
-Cocoa
------
-.. note:: The Cocoa framework is only available on Mac OSX. Don't pick this if you're writing a cross-platform application!
-PyObjC
-~~~~~~
-.. note:: Only available on Mac OSX. Don't pick this if you're writing a cross-platform application.
+***************************************
+Pyjs Desktop (formerly Pyjamas Desktop)
+***************************************
-wxPython
---------
-wxPython is a GUI toolkit for the Python programming language. It allows
-Python programmers to create programs with a robust, highly functional
-graphical user interface, simply and easily. It is implemented as a Python
-extension module (native code) that wraps the popular wxWidgets cross platform
-GUI library, which is written in C++.
-
-Install (Stable)
-~~~~~~~~~~~~~~~~
-*Go to http://www.wxpython.org/download.php#stable and download the appropriate
-package for your OS.*
+Pyjs Desktop is a application widget set for desktop and a cross-platform
+framework. It allows the exact same Python web application source code to be
+executed as a standalone desktop application.
+
+
+The main website: `pyjs `_.
+
+
+**
+Qt
+**
+
+`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.
-GTk
----
-PyGTK provides Python bindings for the GTK+ toolkit. Like the GTK+ library
-itself, it is currently licensed under the GNU LGPL. It is worth noting that
-PyGTK only currently supports the Gtk-2.X API (NOT Gtk-3.0). It is currently
-recommended that PyGTK not be used for new projects and existing applications
-be ported from PyGTK to PyGObject.
+***********
+PySimpleGUI
+***********
+
+`PySimpleGUI `_ is a wrapper for Tkinter
+and Qt (others on the way). The amount of code required to implement custom
+GUIs is much shorter using PySimpleGUI than if the same GUI were written
+directly using Tkinter or Qt. PySimpleGUI code can be "ported" between GUI
+frameworks by changing import statements.
+
+.. code-block:: console
+
+ $ pip install pysimplegui
+
+PySimpleGUI is contained in a single PySimpleGUI.py file. Should pip
+installation be impossible, copying the PySimpleGUI.py file into a project's
+folder is all that's required to import and begin using.
+
+
+****
+Toga
+****
+
+`Toga `_ is a Python native, OS native,
+cross platform GUI toolkit. Toga consists of a library of base components with a
+shared interface to simplify platform-agnostic GUI development.
+
+Toga is available on macOS, Windows, Linux (GTK), and mobile platforms such as
+Android and iOS.
+
+
+**
Tk
---
-Tkinter is a thin object-oriented layer on top of Tcl/Tk. It has the advantage
+**
+
+Tkinter is a thin object-oriented layer on top of Tcl/Tk. **It has the advantage
of being included with the Python standard library, making it the most
-convenient and compatible toolkit to program with.
+convenient and compatible toolkit to program with.**
Both Tk and Tkinter are available on most Unix platforms, as well as on Windows
and Macintosh systems. Starting with the 8.0 release, Tk offers native look and
feel on all platforms.
-There's a good multi-language Tk tutorial with Python examples at
-`TkDocs `_. There's more information
+There's a good multi-language Tk tutorial with Python examples at `TkDocs
+`_. There's more information
available on the `Python Wiki `_.
-Kivy
-----
-`Kivy `_ is a Python library for development of multi-touch
-enabled media rich applications. The aim is to allow for quick and easy
-interaction design and rapid prototyping, while making your code reusable
-and deployable.
-Kivy is written in Python, based on OpenGL and supports different input devices
-such as: Mouse, Dual Mouse, TUIO, WiiMote, WM_TOUCH, HIDtouch, Apple's products and so on.
+********
+wxPython
+********
-Kivy is actively being developed by a community and free to use. It operates
-on all major platforms (Linux, OSX, Windows, Android).
+wxPython is a GUI toolkit for the Python programming language. It allows Python
+programmers to create programs with a robust, highly functional graphical user
+interface, simply and easily. It is implemented as a Python extension module
+(native code) that wraps the popular wxWidgets cross platform GUI library, which
+is written in C++.
-The main resource for information is the website: http://kivy.org
+**Install (Stable) wxPython**
+*go to https://www.wxpython.org/pages/downloads/ and download the appropriate
+package for your OS.*
diff --git a/docs/scenarios/imaging.rst b/docs/scenarios/imaging.rst
index 8defa0b73..8fe7e08fe 100644
--- a/docs/scenarios/imaging.rst
+++ b/docs/scenarios/imaging.rst
@@ -1,74 +1,112 @@
-==================
+
+##################
Image Manipulation
-==================
+##################
+
+.. image:: /_static/photos/34575689432_3de8e9a348_k_d.jpg
+
+Most image processing and manipulation techniques can be carried out
+effectively using two libraries: Python Imaging Library (PIL) and Open Source
+Computer Vision (OpenCV).
+
+A brief description of both is given below.
-.. todo::
- Add introduction about image manipulation and its Python libraries.
+**********************
Python Imaging Library
-----------------------
+**********************
The `Python Imaging Library `_, or PIL
-for short, is *the* library for image manipulation in Python.
+for short, is one of the core libraries for image manipulation in Python. Unfortunately,
+its development has stagnated, with its last release in 2009.
-It works with Python 1.5.2 and above, including 2.5, 2.6 and 2.7. Unfortunately,
-it doesn't work with 3.0+ yet.
+Luckily for you, there's an actively-developed fork of PIL called
+`Pillow `_ -- it's easier to install, runs on
+all major operating systems, and supports Python 3.
Installation
~~~~~~~~~~~~
-PIL has a reputation of not being very straightforward to install. Listed below
-are installation notes on various systems.
+Before installing Pillow, you'll have to install Pillow's prerequisites. Find
+the instructions for your platform in the
+`Pillow installation instructions `_.
-Also, there's a fork named `Pillow `_ which is easier
-to install. It has good setup instructions for all platforms.
+After that, it's straightforward:
-Installing on Linux
-~~~~~~~~~~~~~~~~~~~
+.. code-block:: console
-Arch Linux
-``````````
+ $ pip install Pillow
-PIL is maintained in the official community repository, and installed with the system installer as:
+Example
+~~~~~~~
-.. code-block:: bash
+.. code-block:: python
- $ sudo pacman -S python2-imaging
+ from PIL import Image, ImageFilter
+ #Read image
+ im = Image.open( 'image.jpg' )
+ #Display image
+ im.show()
-Ubuntu 12.10
-````````````
+ #Applying a filter to the image
+ im_sharp = im.filter( ImageFilter.SHARPEN )
+ #Saving the filtered image to a new file
+ im_sharp.save( 'image_sharpened.jpg', 'JPEG' )
-Can be installed on the command line as:
+ #Splitting the image into its respective bands, i.e. Red, Green,
+ #and Blue for RGB
+ r,g,b = im_sharp.split()
-.. code-block:: bash
+ #Viewing EXIF data embedded in image
+ exif_data = im._getexif()
+ exif_data
- $ sudo apt-get install python-imaging
+There are more examples of the Pillow library in the
+`Pillow tutorial `_.
-Installing on Mac OS X
-~~~~~~~~~~~~~~~~~~~~~~
+***************************
+Open Source Computer Vision
+***************************
+
+Open Source Computer Vision, more commonly known as OpenCV, is a more advanced
+image manipulation and processing software than PIL. It has been implemented
+in several languages and is widely used.
+
+Installation
+~~~~~~~~~~~~
-PIP doesn't know about the Mac OS X Freetype paths. To rectify that:
+In Python, image processing using OpenCV is implemented using the ``cv2`` and
+``NumPy`` modules. The `installation instructions for OpenCV
+`_
+should guide you through configuring the project for yourself.
-.. code-block:: bash
+NumPy can be downloaded from the Python Package Index(PyPI):
- $ ln -s /usr/X11/include/freetype2 /usr/local/include/
- $ ln -s /usr/X11/include/ft2build.h /usr/local/include/
- $ ln -s /usr/X11/lib/libfreetype.6.dylib /usr/local/lib/
- $ ln -s /usr/X11/lib/libfreetype.6.dylib /usr/local/lib/libfreetype.dylib
+.. code-block:: console
-then:
+ $ pip install numpy
-.. code-block:: bash
- $ brew install libjpeg
- $ pip install PIL
+Example
+~~~~~~~
+.. code-block:: python
-Installing on Windows
-~~~~~~~~~~~~~~~~~~~~~
+ import cv2
+ #Read Image
+ img = cv2.imread('testimg.jpg')
+ #Display Image
+ cv2.imshow('image',img)
+ cv2.waitKey(0)
+ cv2.destroyAllWindows()
-.. todo::
- Notes on installing on Windows machines
+ #Applying Grayscale filter to image
+ gray = cv2.cvtColor(img, cv2.COLOR_BGR2GRAY)
+ #Saving filtered image to new file
+ cv2.imwrite('graytest.jpg',gray)
+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
new file mode 100644
index 000000000..1c3663777
--- /dev/null
+++ b/docs/scenarios/json.rst
@@ -0,0 +1,48 @@
+
+####
+JSON
+####
+
+.. image:: /_static/photos/33928819683_97b5c6a184_k_d.jpg
+
+The `json `_ library can parse
+JSON from strings or files. The library parses JSON into a Python dictionary
+or list. It can also convert Python dictionaries or lists into JSON strings.
+
+
+************
+Parsing JSON
+************
+
+Take the following string containing JSON data:
+
+.. code-block:: python
+
+ json_string = '{"first_name": "Guido", "last_name":"Rossum"}'
+
+It can be parsed like this:
+
+.. code-block:: python
+
+ import json
+ parsed_json = json.loads(json_string)
+
+and can now be used as a normal dictionary:
+
+.. code-block:: python
+
+ print(parsed_json['first_name'])
+ "Guido"
+
+You can also convert the following to JSON:
+
+.. code-block:: python
+
+ d = {
+ 'first_name': 'Guido',
+ 'second_name': 'Rossum',
+ 'titles': ['BDFL', 'Developer'],
+ }
+
+ print(json.dumps(d))
+ '{"first_name": "Guido", "last_name": "Rossum", "titles": ["BDFL", "Developer"]}'
diff --git a/docs/scenarios/ml.rst b/docs/scenarios/ml.rst
new file mode 100644
index 000000000..b3655c819
--- /dev/null
+++ b/docs/scenarios/ml.rst
@@ -0,0 +1,125 @@
+
+
+################
+Machine Learning
+################
+
+.. image:: /_static/photos/34018729885_002ced9b54_k_d.jpg
+
+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 listed 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 ease of, 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 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 `_.
diff --git a/docs/scenarios/network.rst b/docs/scenarios/network.rst
index 56031aa9d..bb751b78e 100644
--- a/docs/scenarios/network.rst
+++ b/docs/scenarios/network.rst
@@ -1,32 +1,46 @@
+
+##########
Networking
-==========
+##########
+
+.. image:: /_static/photos/34151833832_6bdfd930af_k_d.jpg
+
+*******
Twisted
--------
+*******
-`Twisted `_ is an event-driven networking
+`Twisted `_ is an event-driven networking
engine. It can be used to build applications around many different networking
-protocols, including http servers and clients, applications using SMTP, POP3,
-IMAP or SSH protocols, instant messaging and `much more `_.
+protocols, including HTTP servers and clients, applications using SMTP, POP3,
+IMAP, or SSH protocols, instant messaging,
+and `much more `_.
+
+*****
PyZMQ
------
+*****
-`PyZMQ `_ is the Python binding for `ZeroMQ `_,
-which is a high-performance asynchronous messaging library. One great advantage is that ZeroMQ
-can be used for message queuing without a message broker. The basic patterns for this are:
+`PyZMQ `_ is the Python binding for
+`ZeroMQ `_, which is a high-performance asynchronous
+messaging library. One great advantage of ZeroMQ is that it can be used for
+message queuing without a message broker. The basic patterns for this are:
-- request-reply: connects a set of clients to a set of services. This is a remote procedure call
- and task distribution pattern.
-- publish-subscribe: connects a set of publishers to a set of subscribers. This is a data
- distribution pattern.
-- push-pull (or pipeline): connects nodes in a fan-out / fan-in pattern that can have multiple
- steps, and loops. This is a parallel task distribution and collection pattern.
+- request-reply: connects a set of clients to a set of services. This is a
+ remote procedure call and task distribution pattern.
+- publish-subscribe: connects a set of publishers to a set of subscribers.
+ This is a data distribution pattern.
+- push-pull (or pipeline): connects nodes in a fan-out/fan-in pattern that
+ can have multiple steps and loops. This is a parallel task distribution
+ and collection pattern.
For a quick start, read the `ZeroMQ guide `_.
+
+******
gevent
-------
-`gevent `_ is a coroutine-based Python networking library
-that uses greenlets and libevent event loop.
+******
+`gevent `_ is a coroutine-based Python networking
+library that uses greenlets to provide a high-level synchronous API on top of
+the libev event loop.
diff --git a/docs/scenarios/scientific.rst b/docs/scenarios/scientific.rst
index 7f9a66cb3..bb0547323 100644
--- a/docs/scenarios/scientific.rst
+++ b/docs/scenarios/scientific.rst
@@ -1,73 +1,138 @@
-=======================
+
+#######################
Scientific Applications
-=======================
+#######################
+
+.. image:: /_static/photos/33925223870_97e44f5629_k_d.jpg
+
+*******
Context
-:::::::
+*******
-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.
+Python is frequently used for high-performance scientific applications. It
+is widely used in academia and scientific projects because it is easy to write
+and performs well.
-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`_
+Due to its high performance nature, scientific computing in Python often
+utilizes 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
of the Python guide. However, a comprehensive introduction to the scientific
Python ecosystem can be found in the `Python Scientific Lecture Notes
-`_
+`_.
+
+
+*****
+Tools
+*****
+
+IPython
+-------
+
+`IPython `_ is an enhanced version of Python interpreter,
+which provides features of great interest to scientists. The `inline mode`
+allows 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 allows you to
+store chunks of Python code alongside the results and additional comments
+(HTML, LaTeX, Markdown). The notebook can then be shared and exported in various
+file formats.
+
+*********
Libraries
-:::::::::
+*********
NumPy
-----
`NumPy `_ is a low level library written in C (and
-FORTRAN) for high level mathematical functions. NumPy cleverly overcomes the
+Fortran) for high level mathematical functions. NumPy cleverly overcomes the
problem of running slower algorithms on Python by using multidimensional arrays
and functions that operate on arrays. Any algorithm can then be expressed as a
function on arrays, allowing the algorithms to be run quickly.
-
NumPy is part of the SciPy project, and is released as a separate library so
-people who only need the basic requirements can just use NumPy.
+people who only need the basic requirements can use it without installing the
+rest of SciPy.
-NumPy is compatible with Python versions 2.4 through to 2.7.2 and 3.1+.
+NumPy is compatible with Python versions 2.4 through 2.7.2 and 3.1+.
Numba
-----
-Numba is an Numpy aware Python compiler (just-in-time (JIT) specializing
-compiler) which compiles annotated Python (and Numpy) code to LLVM (Low Level
-Virtual Machine) (through special decorators).
-Briefly, Numba using system that compiles Python code with LLVM to code which
+
+`Numba `_ is a NumPy aware Python compiler
+(just-in-time (JIT) specializing compiler) which compiles annotated Python (and
+NumPy) code to LLVM (Low Level Virtual Machine) through special decorators.
+Briefly, Numba uses a system that compiles Python code with LLVM to code which
can be natively executed at runtime.
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
-example: linear algebra, integration (calculus), ordinary differential equation
-solvers and signal processing.
+`SciPy `_ is a library that uses NumPy for more mathematical
+functions. SciPy uses NumPy arrays as the basic data structure, and comes
+with modules for various commonly used tasks in scientific programming,
+including linear algebra, integration (calculus), ordinary differential equation
+solving, and signal processing.
Matplotlib
----------
`Matplotlib `_ is a flexible plotting
library for creating interactive 2D and 3D plots that can also be saved as
-manuscript-quality figures. The API in many ways reflects that of `MATLAB
+manuscript-quality figures. The API in many ways reflects that of `MATLAB
`_, easing transition of MATLAB
-users to Python. Many examples, along with the source code to re-create them,
-can be browsed at the `matplotlib gallery
+users to Python. Many examples, along with the source code to recreate them,
+are available in the `matplotlib gallery
`_.
+Pandas
+------
+
+`Pandas `_ is a data manipulation library
+based on NumPy 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,
+heterogeneous data tables with name indexing, time series operations, and
+auto-alignment of data.
+
+xarray
+------
+
+`xarray `_ is similar to Pandas, but it
+is intended for wrapping multidimensional scientific data. By labelling the
+data with dimensions, coordinates, and attributes, it makes complex
+multidimensional operations clearer and more intuitive. It also wraps
+matplotlib for quick plotting, and can apply most operations in parallel using
+`dask `_.
+
+
+Rpy2
+----
+
+`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 `_
+bindings.
+
+PsychoPy
+--------
+
+`PsychoPy `_ is a library for cognitive scientists
+allowing the creation of cognitive psychology and neuroscience experiments.
+The library handles presentation of stimuli, scripting of experimental design,
+and data collection.
+
+
+*********
Resources
-:::::::::
+*********
-Installation of scientific Python packages can be troublesome. Many of these
-packages are implemented as Python C extensions which need to be compiled.
+Installation of scientific Python packages can be troublesome, as many of
+these packages are implemented as Python C extensions which need to be compiled.
This section lists various so-called scientific Python distributions which
provide precompiled and easy-to-install collections of scientific Python
packages.
@@ -75,31 +140,27 @@ packages.
Unofficial Windows Binaries for Python Extension Packages
---------------------------------------------------------
-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
-general list. It might be a good idea to check it out if you're on Windows.
-
-Enthought Python Distribution (EPD)
------------------------------------
-
-Installing NumPy and SciPy can be a daunting task. Which is why the
-`Enthought Python distribution `_ was created. With
-Enthought, scientific python has never been easier (one click to install about
-100 scientific python packages). The Enthought Python Distribution comes in two
-variants: a free version `EPD Free `_
-and a paid version with various `pricing options.
-`_
+Many people who do scientific computing are on Windows, yet many of the
+scientific computing packages are notoriously difficult to build and install on
+this platform. `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 general list. If you're on Windows, you may want to check it
+out.
Anaconda
--------
-`Continuum Analytics `_ offers the `Anaconda
-Python Distribution `_ which
-includes all the common scientific python packages and additionally many
-packages related to data analytics and big data. Anaconda comes in two
-flavors, a paid for version and a completely free and open source community
-edition, Anaconda CE, which contains a slightly reduced feature set. Free
-licenses for the paid-for version are available for academics and researchers.
+The `Anaconda Python Distribution `_
+includes all the common scientific Python packages as well as many packages
+related to data analytics and big data. Anaconda itself is free, and a number
+of proprietary add-ons are available for a fee. Free licenses for the
+add-ons are available for academics and researchers.
+
+Canopy
+------
+
+`Canopy `_ is another scientific
+Python distribution, produced by `Enthought `_.
+A limited 'Canopy Express' variant is available for free, but Enthought
+charges for the full distribution. Free licenses are available for academics.
diff --git a/docs/scenarios/scrape.rst b/docs/scenarios/scrape.rst
index b4f10b2fa..527719200 100644
--- a/docs/scenarios/scrape.rst
+++ b/docs/scenarios/scrape.rst
@@ -1,62 +1,74 @@
+
+#############
HTML Scraping
-=============
+#############
+
+.. image:: /_static/photos/34268661876_442428e122_k_d.jpg
+
+************
Web Scraping
-------------
+************
Web sites are written using HTML, which means that each web page is a
structured document. Sometimes it would be great to obtain some data from
them and preserve the structure while we're at it. Web sites don't always
-provide their data in comfortable formats such as ``csv`` or ``json``.
+provide their data in comfortable formats such as CSV or JSON.
This is where web scraping comes in. Web scraping is the practice of using a
computer program to sift through a web page and gather the data that you need
in a format most useful to you while at the same time preserving the structure
of the data.
+
+*****************
lxml and Requests
------------------
+*****************
`lxml `_ is a pretty extensive library written for parsing
-XML and HTML documents really fast. It even handles messed up tags. We will
-also be using the `Requests `_
-module instead of the already built-in urlib2 due to improvements in speed and
-readability. You can easily install both using ``pip install lxml`` and
+XML and HTML documents very quickly, even handling messed up tags in the
+process. We will also be using the
+`Requests `_ module instead of the
+already built-in urllib2 module due to improvements in speed and readability.
+You can easily install both using ``pip install lxml`` and
``pip install requests``.
-Lets start with the imports:
+Let's start with the imports:
.. code-block:: python
from lxml import html
import requests
-Next we will use ``requests.get`` to retrieve the web page with our data
-and parse it using the ``html`` module and save the results in ``tree``:
+Next we will use ``requests.get`` to retrieve the web page with our data,
+parse it using the ``html`` module, and save the results in ``tree``:
.. code-block:: python
page = requests.get('http://econpy.pythonanywhere.com/ex/001.html')
- tree = html.fromstring(page.text)
+ tree = html.fromstring(page.content)
+
+(We need to use ``page.content`` rather than ``page.text`` because
+``html.fromstring`` implicitly expects ``bytes`` as input.)
``tree`` now contains the whole HTML file in a nice tree structure which
-we can go over two different ways: XPath and CSSSelect. In this example, I
+we can go over two different ways: XPath and CSSSelect. In this example, we
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
can right click an element, choose 'Inspect element', highlight the code,
-right click again and choose 'Copy XPath'.
+right click again, and choose 'Copy XPath'.
After a quick analysis, we see that in our page the data is contained in
-two elements - one is a div with title 'buyer-name' and the other is a
+two elements -- one is a div with title 'buyer-name' and the other is a
span with class 'item-price':
-::
+.. code-block:: html
Carson Busses
$29.95
@@ -71,12 +83,12 @@ Knowing this we can create the correct XPath query and use the lxml
#This will create a list of prices
prices = tree.xpath('//span[@class="item-price"]/text()')
-Lets see what we got exactly:
+Let's see what we got exactly:
.. code-block:: python
- print 'Buyers: ', buyers
- print 'Prices: ', prices
+ print('Buyers: ', buyers)
+ print('Prices: ', prices)
::
@@ -96,6 +108,6 @@ a web page using lxml and Requests. We have it stored in memory as two
lists. Now we can do all sorts of cool stuff with it: we can analyze it
using Python or we can save it to a file and share it with the world.
-A cool idea to think about is modifying this script to iterate through
-the rest of the pages of this example dataset or rewriting this
+Some more cool ideas to think about are modifying this script to iterate
+through the rest of the pages of this example dataset, or rewriting this
application to use threads for improved speed.
diff --git a/docs/scenarios/serialization.rst b/docs/scenarios/serialization.rst
new file mode 100644
index 000000000..3edc6aaa2
--- /dev/null
+++ b/docs/scenarios/serialization.rst
@@ -0,0 +1,237 @@
+
+##################
+Data Serialization
+##################
+
+.. image:: /_static/photos/33467946364_3e59bd376a_k_d.jpg
+
+
+***************************
+What is data serialization?
+***************************
+
+Data serialization is the process of converting structured data to a format
+that allows sharing or storage of the data in a form that allows recovery of its original
+structure. In some cases, the secondary intention of data
+serialization is to minimize the data's size which then
+reduces disk space or bandwidth requirements.
+
+********************
+Flat vs. Nested data
+********************
+
+Before beginning to serialize data, it is important to identify or decide how the
+data should be structured during data serialization - flat or nested.
+The differences in the two styles are shown in the below examples.
+
+Flat style:
+
+.. code-block:: python
+
+ { "Type" : "A", "field1": "value1", "field2": "value2", "field3": "value3" }
+
+
+Nested style:
+
+.. code-block:: python
+
+ {"A"
+ { "field1": "value1", "field2": "value2", "field3": "value3" } }
+
+
+For more reading on the two styles, please see the discussion on
+`Python mailing list `__,
+`IETF mailing list `__ and
+`in stackexchange `__.
+
+****************
+Serializing Text
+****************
+
+=======================
+Simple file (flat data)
+=======================
+
+If the data to be serialized is located in a file and contains flat data, Python offers two methods to serialize data.
+
+repr
+----
+
+The repr method in Python takes a single object parameter and returns a printable representation of the input:
+
+.. code-block:: python
+
+ # input as flat text
+ a = { "Type" : "A", "field1": "value1", "field2": "value2", "field3": "value3" }
+
+ # the same input can also be read from a file
+ a = open('/tmp/file.py', 'r')
+
+ # returns a printable representation of the input;
+ # the output can be written to a file as well
+ print(repr(a))
+
+ # write content to files using repr
+ with open('/tmp/file.py') as f:f.write(repr(a))
+
+
+ast.literal_eval
+----------------
+
+The literal_eval method safely parses and evaluates an expression for a Python datatype.
+Supported data types are: strings, numbers, tuples, lists, dicts, booleans, and None.
+
+.. code-block:: python
+
+ with open('/tmp/file.py', 'r') as f: inp = ast.literal_eval(f.read())
+
+====================
+CSV file (flat data)
+====================
+
+The CSV module in Python implements classes to read and write tabular
+data in CSV format.
+
+Simple example for reading:
+
+.. code-block:: python
+
+ # Reading CSV content from a file
+ import csv
+ with open('/tmp/file.csv', newline='') as f:
+ reader = csv.reader(f)
+ for row in reader:
+ print(row)
+
+Simple example for writing:
+
+.. code-block:: python
+
+ # Writing CSV content to a file
+ import csv
+ with open('/temp/file.csv', 'w', newline='') as f:
+ writer = csv.writer(f)
+ writer.writerows(iterable)
+
+
+The module's contents, functions, and examples can be found
+`in the Python documentation `__.
+
+==================
+YAML (nested data)
+==================
+
+There are many third party modules to parse and read/write YAML file
+structures in Python. One such example is below.
+
+.. code-block:: python
+
+ # Reading YAML content from a file using the load method
+ import yaml
+ with open('/tmp/file.yaml', 'r', newline='') as f:
+ try:
+ print(yaml.load(f))
+ except yaml.YAMLError as ymlexcp:
+ print(ymlexcp)
+
+Documentation on the third party module can be found
+`in the PyYAML Documentation `__.
+
+=======================
+JSON file (nested data)
+=======================
+
+Python's JSON module can be used to read and write JSON files.
+Example code is below.
+
+Reading:
+
+.. code-block:: python
+
+ # Reading JSON content from a file
+ import json
+ with open('/tmp/file.json', 'r') as f:
+ data = json.load(f)
+
+Writing:
+
+.. code-block:: python
+
+ # Writing JSON content to a file using the dump method
+ import json
+ with open('/tmp/file.json', 'w') as f:
+ json.dump(data, f, sort_keys=True)
+
+=================
+XML (nested data)
+=================
+
+XML parsing in Python is possible using the `xml` package.
+
+Example:
+
+.. code-block:: python
+
+ # reading XML content from a file
+ import xml.etree.ElementTree as ET
+ tree = ET.parse('country_data.xml')
+ root = tree.getroot()
+
+More documentation on using the `xml.dom` and `xml.sax` packages can be found
+`in the Python XML library documentation `__.
+
+
+*******
+Binary
+*******
+
+=======================
+NumPy Array (flat data)
+=======================
+
+Python's NumPy array can be used to serialize and deserialize data to and from byte representation.
+
+Example:
+
+.. code-block:: python
+
+ import NumPy as np
+
+ # Converting NumPy array to byte format
+ byte_output = np.array([ [1, 2, 3], [4, 5, 6], [7, 8, 9] ]).tobytes()
+
+ # Converting byte format back to NumPy array
+ array_format = np.frombuffer(byte_output)
+
+
+
+====================
+Pickle (nested data)
+====================
+
+The native data serialization module for Python is called `Pickle
+`_.
+
+Here's an example:
+
+.. code-block:: python
+
+ import pickle
+
+ #Here's an example dict
+ grades = { 'Alice': 89, 'Bob': 72, 'Charles': 87 }
+
+ #Use dumps to convert the object to a serialized string
+ serial_grades = pickle.dumps( grades )
+
+ #Use loads to de-serialize an object
+ received_grades = pickle.loads( serial_grades )
+
+
+********
+Protobuf
+********
+
+If you're looking for a serialization module that has support in multiple
+languages, Google's `Protobuf
+`_ library is an option.
diff --git a/docs/scenarios/speed.rst b/docs/scenarios/speed.rst
index 6aaa96bbd..5dc0cd845 100644
--- a/docs/scenarios/speed.rst
+++ b/docs/scenarios/speed.rst
@@ -1,16 +1,20 @@
+
+#####
Speed
-=====
+#####
+
+.. image:: /_static/photos/33175625804_e225b90f3e_k_d.jpg
CPython, the most commonly used implementation of Python, is slow for CPU bound
tasks. `PyPy`_ is fast.
-Using a slightly modified version of `David Beazleys`_ CPU bound test code
+Using a slightly modified version of `David Beazley's`_ CPU bound test code
(added loop for multiple tests), you can see the difference between CPython
and PyPy's processing.
-::
+.. code-block:: console
- PyPy
+ # PyPy
$ ./pypy -V
Python 2.7.1 (7773f8fc4223, Nov 18 2011, 18:47:10)
[PyPy 1.7.0 with GCC 4.4.3]
@@ -21,9 +25,9 @@ and PyPy's processing.
0.0440690517426
0.0695300102234
-::
+.. code-block:: console
- CPython
+ # CPython
$ ./python -V
Python 2.7.1
$ ./python measure2.py
@@ -33,8 +37,10 @@ and PyPy's processing.
1.54693889618
1.60109114647
+
+*******
Context
-:::::::
+*******
The GIL
@@ -61,13 +67,159 @@ The GIL
`Special care`_ must be taken when writing C extensions to make sure you
register your threads with the interpreter.
+
+************
C Extensions
-::::::::::::
+************
Cython
------
+`Cython `_ implements a superset of the Python language
+with which you are able to write C and C++ modules for Python. Cython also
+allows you to call functions from compiled C libraries. Using Cython allows
+you to take advantage of Python's strong typing of variables and operations.
+
+Here's an example of strong typing with Cython:
+
+.. code-block:: cython
+
+ def primes(int kmax):
+ """Calculation of prime numbers with additional
+ Cython keywords"""
+
+ cdef int n, k, i
+ cdef int p[1000]
+ result = []
+ if kmax > 1000:
+ kmax = 1000
+ k = 0
+ n = 2
+ while k < kmax:
+ i = 0
+ while i < k and n % p[i] != 0:
+ i = i + 1
+ if i == k:
+ p[k] = n
+ k = k + 1
+ result.append(n)
+ n = n + 1
+ return result
+
+
+This implementation of an algorithm to find prime numbers has some additional
+keywords compared to the next one, which is implemented in pure Python:
+
+.. code-block:: python
+
+ def primes(kmax):
+ """Calculation of prime numbers in standard Python syntax"""
+
+ p = range(1000)
+ result = []
+ if kmax > 1000:
+ kmax = 1000
+ k = 0
+ n = 2
+ while k < kmax:
+ i = 0
+ while i < k and n % p[i] != 0:
+ i = i + 1
+ if i == k:
+ p[k] = n
+ k = k + 1
+ result.append(n)
+ n = n + 1
+ return result
+
+Notice that in the Cython version you declare integers and integer arrays
+to be compiled into C types while also creating a Python list:
+
+
+.. code-block:: cython
+
+ def primes(int kmax):
+ """Calculation of prime numbers with additional
+ Cython keywords"""
+
+ cdef int n, k, i
+ cdef int p[1000]
+ result = []
+
+
+.. code-block:: python
+
+ def primes(kmax):
+ """Calculation of prime numbers in standard Python syntax"""
+
+ p = range(1000)
+ result = []
+
+What is the difference? In the upper Cython version you can see the
+declaration of the variable types and the integer array in a similar way as
+in standard C. For example `cdef int n,k,i` in line 3. This additional type
+declaration (i.e. integer) allows the Cython compiler to generate more
+efficient C code from the second version. While standard Python code is saved
+in :file:`*.py` files, Cython code is saved in :file:`*.pyx` files.
+
+What's the difference in speed? Let's try it!
+
+.. code-block:: python
+
+ import time
+ # Activate pyx compiler
+ import pyximport
+ pyximport.install()
+ import primesCy # primes implemented with Cython
+ import primes # primes implemented with Python
+
+ print("Cython:")
+ t1 = time.time()
+ print(primesCy.primes(500))
+ t2 = time.time()
+ print("Cython time: %s" % (t2 - t1))
+ print("")
+ print("Python")
+ t1 = time.time()
+ print(primes.primes(500))
+ t2 = time.time()
+ print("Python time: %s" % (t2 - t1))
+
+
+These lines both need a remark:
+
+.. code-block:: python
+
+ import pyximport
+ pyximport.install()
+
+
+The `pyximport` module allows you to import :file:`*.pyx` files (e.g.,
+:file:`primesCy.pyx`) with the Cython-compiled version of the `primes`
+function. The `pyximport.install()` command allows the Python interpreter to
+start the Cython compiler directly to generate C code, which is automatically
+compiled to a :file:`*.so` C library. Cython is then able to import this
+library for you in your Python code, easily and efficiently. With the
+`time.time()` function you are able to compare the time between these 2
+different calls to find 500 prime numbers. On a standard notebook (dual core
+AMD E-450 1.6 GHz), the measured values are:
+
+.. code-block:: console
+
+ Cython time: 0.0054 seconds
+
+ Python time: 0.0566 seconds
+
+
+And here is the output of an embedded `ARM beaglebone `_ machine:
+
+.. code-block:: console
+
+ Cython time: 0.0196 seconds
+
+ Python time: 0.3302 seconds
+
Pyrex
-----
@@ -76,17 +228,214 @@ Pyrex
Shedskin?
---------
-Numba
------
-.. todo:: Write about Numba and the autojit compiler for NumPy
-Threading
-:::::::::
+***********
+Concurrency
+***********
-Threading
+Concurrent.futures
+------------------
+
+The `concurrent.futures`_ module is a module in the standard library that
+provides a "high-level interface for asynchronously executing callables". It
+abstracts away a lot of the more complicated details about using multiple
+threads or processes for concurrency, and allows the user to focus on
+accomplishing the task at hand.
+
+The `concurrent.futures`_ module exposes two main classes, the
+`ThreadPoolExecutor` and the `ProcessPoolExecutor`. The ThreadPoolExecutor
+will create a pool of worker threads that a user can submit jobs to. These jobs
+will then be executed in another thread when the next worker thread becomes
+available.
+
+The ProcessPoolExecutor works in the same way, except instead of using multiple
+threads for its workers, it will use multiple processes. This makes it possible
+to side-step the GIL; however, because of the way things are passed to worker
+processes, only picklable objects can be executed and returned.
+
+Because of the way the GIL works, a good rule of thumb is to use a
+ThreadPoolExecutor when the task being executed involves a lot of blocking
+(i.e. making requests over the network) and to use a ProcessPoolExecutor
+executor when the task is computationally expensive.
+
+There are two main ways of executing things in parallel using the two
+Executors. One way is with the `map(func, iterables)` method. This works
+almost exactly like the builtin `map()` function, except it will execute
+everything in parallel.
+
+.. code-block:: python
+
+ from concurrent.futures import ThreadPoolExecutor
+ import requests
+
+ def get_webpage(url):
+ page = requests.get(url)
+ return page
+
+ pool = ThreadPoolExecutor(max_workers=5)
+
+ my_urls = ['http://google.com/']*10 # Create a list of urls
+
+ for page in pool.map(get_webpage, my_urls):
+ # Do something with the result
+ print(page.text)
+
+For even more control, the `submit(func, *args, **kwargs)` method will schedule
+a callable to be executed ( as `func(*args, **kwargs)`) and returns a `Future`_
+object that represents the execution of the callable.
+
+The Future object provides various methods that can be used to check on the
+progress of the scheduled callable. These include:
+
+cancel()
+ Attempt to cancel the call.
+cancelled()
+ Return True if the call was successfully cancelled.
+running()
+ Return True if the call is currently being executed and cannot be
+ cancelled.
+done()
+ Return True if the call was successfully cancelled or finished running.
+result()
+ Return the value returned by the call. Note that this call will block until
+ the scheduled callable returns by default.
+exception()
+ Return the exception raised by the call. If no exception was raised then
+ this returns None. Note that this will block just like `result()`.
+add_done_callback(fn)
+ Attach a callback function that will be executed (as `fn(future)`) when the
+ scheduled callable returns.
+
+
+.. code-block:: python
+
+ from concurrent.futures import ProcessPoolExecutor, as_completed
+
+ def is_prime(n):
+ if n % 2 == 0:
+ return n, False
+
+ sqrt_n = int(n**0.5)
+ for i in range(3, sqrt_n + 1, 2):
+ if n % i == 0:
+ return n, False
+ return n, True
+
+ PRIMES = [
+ 112272535095293,
+ 112582705942171,
+ 112272535095293,
+ 115280095190773,
+ 115797848077099,
+ 1099726899285419]
+
+ futures = []
+ with ProcessPoolExecutor(max_workers=4) as pool:
+ # Schedule the ProcessPoolExecutor to check if a number is prime
+ # and add the returned Future to our list of futures
+ for p in PRIMES:
+ fut = pool.submit(is_prime, p)
+ futures.append(fut)
+
+ # As the jobs are completed, print out the results
+ for number, result in as_completed(futures):
+ if result:
+ print("{} is prime".format(number))
+ else:
+ print("{} is not prime".format(number))
+
+The `concurrent.futures`_ module contains two helper functions for working with
+Futures. The `as_completed(futures)` function returns an iterator over the list
+of futures, yielding the futures as they complete.
+
+The `wait(futures)` function will simply block until all futures in the list of
+futures provided have completed.
+
+For more information, on using the `concurrent.futures`_ module, consult the
+official documentation.
+
+threading
---------
+The standard library comes with a `threading`_ module that allows a user to
+work with multiple threads manually.
+
+Running a function in another thread is as simple as passing a callable and
+its arguments to `Thread`'s constructor and then calling `start()`:
+
+.. code-block:: python
+
+ from threading import Thread
+ import requests
+
+ def get_webpage(url):
+ page = requests.get(url)
+ return page
+
+ some_thread = Thread(get_webpage, 'http://google.com/')
+ some_thread.start()
+
+To wait until the thread has terminated, call `join()`:
+
+.. code-block:: python
+
+ some_thread.join()
+
+After calling `join()`, it is always a good idea to check whether the thread is
+still alive (because the join call timed out):
+
+.. code-block:: python
+
+ if some_thread.is_alive():
+ print("join() must have timed out.")
+ else:
+ print("Our thread has terminated.")
+
+Because multiple threads have access to the same section of memory, sometimes
+there might be situations where two or more threads are trying to write to the
+same resource at the same time or where the output is dependent on the sequence
+or timing of certain events. This is called a `data race`_ or race condition.
+When this happens, the output will be garbled or you may encounter problems
+which are difficult to debug. A good example is this `Stack Overflow post`_.
+
+The way this can be avoided is by using a `Lock`_ that each thread needs to
+acquire before writing to a shared resource. Locks can be acquired and released
+through either the contextmanager protocol (`with` statement), or by using
+`acquire()` and `release()` directly. Here is a (rather contrived) example:
+
+
+.. code-block:: python
+
+ from threading import Lock, Thread
+
+ file_lock = Lock()
+
+ def log(msg):
+ with file_lock:
+ open('website_changes.log', 'w') as f:
+ f.write(changes)
+
+ def monitor_website(some_website):
+ """
+ Monitor a website and then if there are any changes,
+ log them to disk.
+ """
+ while True:
+ changes = check_for_changes(some_website)
+ if changes:
+ log(changes)
+
+ websites = ['http://google.com/', ... ]
+ for website in websites:
+ t = Thread(monitor_website, website)
+ t.start()
+
+Here, we have a bunch of threads checking for changes on a list of sites and
+whenever there are any changes, they attempt to write those changes to a file
+by calling `log(changes)`. When `log()` is called, it will wait to acquire
+the lock with `with file_lock:`. This ensures that at any one time, only one
+thread is writing to the file.
Spawning Processes
------------------
@@ -97,8 +446,14 @@ Multiprocessing
.. _`PyPy`: http://pypy.org
-.. _`The GIL`: http://wiki.python.org/moin/GlobalInterpreterLock
+.. _`The GIL`: https://wiki.python.org/moin/GlobalInterpreterLock
.. _`guide`: http://www.dabeaz.com/python/UnderstandingGIL.pdf
.. _`New GIL`: http://www.dabeaz.com/python/NewGIL.pdf
-.. _`Special care`: http://docs.python.org/c-api/init.html#threads
-.. _`David Beazleys`: http://www.dabeaz.com/GIL/gilvis/measure2.py
+.. _`Special care`: https://docs.python.org/c-api/init.html#threads
+.. _`David Beazley's`: http://www.dabeaz.com/GIL/gilvis/measure2.py
+.. _`concurrent.futures`: https://docs.python.org/3/library/concurrent.futures.html
+.. _`Future`: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future
+.. _`threading`: https://docs.python.org/3/library/threading.html
+.. _`Stack Overflow post`: https://stackoverflow.com/questions/26688424/python-threads-are-printing-at-the-same-time-messing-up-the-text-output
+.. _`data race`: https://en.wikipedia.org/wiki/Race_condition
+.. _`Lock`: https://docs.python.org/3/library/threading.html#lock-objects
diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst
index 1520b4bbc..a2c84818b 100644
--- a/docs/scenarios/web.rst
+++ b/docs/scenarios/web.rst
@@ -1,13 +1,19 @@
-================
-Web Applications
-================
+
+#############################
+Web Applications & Frameworks
+#############################
+
+.. image:: /_static/photos/34309496175_b82d104282_k_d.jpg
As a powerful scripting language adapted to both fast prototyping
-and bigger projects, Python is widely used in Web applications
+and bigger projects, Python is widely used in web application
development.
+
+*******
Context
-:::::::
+*******
+
WSGI
@@ -18,13 +24,14 @@ interface between web servers and Python web application frameworks. By
standardizing behavior and communication between web servers and Python web
frameworks, WSGI makes it possible to write portable Python web code that
can be deployed in any :ref:`WSGI-compliant web server `.
-WSGI is documented in `PEP-3333 `_.
+WSGI is documented in :pep:`3333`.
+**********
Frameworks
-::::::::::
+**********
-Broadly speaking, a web framework consist of a set of libraries and a main
+Broadly speaking, a web framework consists of a set of libraries and a main
handler within which you can build custom code to implement a web application
(i.e. an interactive web site). Most web frameworks include patterns and
utilities to accomplish at least the following:
@@ -34,7 +41,7 @@ URL Routing
be invoked
Request and Response Objects
- Encapsulate the information received from or sent to a user's browser
+ Encapsulates the information received from or sent to a user's browser
Template Engine
Allows for separating Python code implementing an application's logic from
@@ -48,67 +55,117 @@ Development Web Server
Django
------
-`Django `_ is a "batteries included" web
-application framework. By providing many utilities and patterns out of the
-box, Django aims to make it possible to build complex, database-backed web
-applications quickly, while encouraging best practices in code written using
-it.
+`Django `_ is a "batteries included" web
+application framework, and is an excellent choice for creating content-oriented
+websites. By providing many utilities and patterns out of the box, Django aims
+to make it possible to build complex, database-backed web applications quickly,
+while encouraging best practices in code written using it.
Django has a large and active community, and many pre-built `re-usable
modules `_ that can be incorporated into a new
project as-is, or customized to fit your needs.
There are annual Django conferences `in the United States
-`_ and `in Europe `_.
+`_, `Europe `_, and `Australia `_.
+The majority of new Python web applications today are built with Django.
Flask
-----
-`Flask `_ is a "microframework" for Python. Rather
-than aiming to provide everything you could possibly need, Flask implements
-the most commonly-used core components of a web application framework, like
-URL routing, request and response objects, and templates. As a user of
-Flask, it is therefore up to you to choose and integrate other components
-you may need, such as database access or form generation and validation. For
-many popular modules, `Extensions `_ may
-already exist to suit your needs.
+`Flask `_ is a "microframework" for Python, and is
+an excellent choice for building smaller applications, APIs, and web services.
-**Support** for flask can best be found in its mailing list. Just shoot an
-email to [email protected] and reply to the confirmation email.
+Building an app with Flask is a lot like writing standard Python modules,
+except some functions have routes attached to them. It's really beautiful.
+Rather than aiming to provide everything you could possibly need, Flask
+implements the most commonly-used core components of a web application
+framework, like URL routing, request and response objects, and templates.
-Werkzeug
---------
+If you use Flask, it is up to you to choose other components for your
+application, if any. For example, database access or form generation and
+validation are not built-in functions of Flask.
+
+This is great, because many web applications don't need those features.
+For those that do, there are many
+`Extensions `_ available that may
+suit your needs. Or, you can easily use any library you want yourself!
+
+Flask is default choice for any Python web application that isn't a good
+fit for Django.
+
+Falcon
+------
-`Werkzeug `_ is not actually a real framework, but
-rather a very powerful set of tools for building web applications. It provides
-URL routing utilities, request and response objects and a basic development
-server. It is mostly used where users need bigger flexibility for their
-application that is not commonly found in other web frameworks.
+`Falcon `_ is a good choice when your goal is
+to build RESTful API microservices that are fast and scalable.
-Support can be found on its `mailing list `_.
+It is a reliable, high-performance Python web framework for building large-scale
+app backends and microservices. Falcon encourages the REST architectural style of
+mapping URIs to resources, trying to do as little as possible while remaining highly effective.
+Falcon highlights four main focuses: speed, reliability, flexibility, and debuggability.
+It implements HTTP through "responders" such as ``on_get()``, ``on_put()``, etc.
+These responders receive intuitive request and response objects.
+
+Tornado
+--------
+
+`Tornado `_ is an asynchronous web framework
+for Python that has its own event loop. This allows it to natively support
+WebSockets, for example. Well-written Tornado applications are known to
+have excellent performance characteristics.
+
+I do not recommend using Tornado unless you think you need it.
Pyramid
--------
-`Pyramid `_ lies somewhere between a big
-framework like Django and the microframeworks: It comes with a lot of libraries
-and functionality and can thus not be considered lightweight. On the other
-hand, it does not provide all the functionality Django does. Instead Pyramid
-brings basic support for most regular tasks and provides a great deal of
-extensibility. Additionally, Pyramid has a huge focus on complete
-`documentation `__. As
-a little extra it comes with the Werkzeug Debugger which allows you to debug a
-running web application in the browser.
+`Pyramid `_ is a very flexible framework with a heavy
+focus on modularity. It comes with a small number of libraries ("batteries")
+built-in, and encourages users to extend its base functionality. A set of
+provided cookiecutter templates helps making new project decisions for users.
+It powers one of the most important parts of python infrastructure
+`PyPI `_.
+
+Pyramid does not have a large user base, unlike Django and Flask. It's a
+capable framework, but not a very popular choice for new Python web
+applications today.
+
+Masonite
+--------
+
+`Masonite `_ is a modern and developer centric, "batteries included", web framework.
-**Support** can also be found in the
-`documentation `__.
+The Masonite framework follows the MVC (Model-View-Controller) architecture pattern and is heavily inspired by frameworks such as Rails and Laravel, so if you are coming to Python from a Ruby or PHP background then you will feel right at home!
+Masonite comes with a lot of functionality out of the box including a powerful IOC container with auto resolving dependency injection, craft command line tools, and the Orator active record style ORM.
+Masonite is perfect for beginners or experienced developers alike and works hard to be fast and easy from install through to deployment. Try it once and you’ll fall in love.
+
+FastAPI
+-------
+
+`FastAPI `_ is a modern web framework for building
+APIs with Python 3.6+.
+
+It has very high performance as it is based on `Starlette `_
+and `Pydantic `_.
+
+FastAPI takes advantage of standard Python type declarations in function parameters
+to declare request parameters and bodies, perform data conversion (serialization,
+parsing), data validation, and automatic API documentation with **OpenAPI 3**
+(including **JSON Schema**).
+
+It includes tools and utilities for security and authentication (including OAuth2 with JWT
+tokens), a dependency injection system, automatic generation of interactive API
+documentation, and other features.
+
+
+***********
Web Servers
-:::::::::::
+***********
.. _nginx-ref:
@@ -116,7 +173,7 @@ Nginx
-----
`Nginx `_ (pronounced "engine-x") is a web server and
-reverse-proxy for HTTP, SMTP and other protocols. It is known for its
+reverse-proxy for HTTP, SMTP, and other protocols. It is known for its
high performance, relative simplicity, and compatibility with many
application servers (like WSGI servers). It also includes handy features
like load-balancing, basic authentication, streaming, and others. Designed
@@ -125,33 +182,69 @@ to serve high-load websites, Nginx is gradually becoming quite popular.
.. _wsgi-servers-ref:
+
+************
WSGI Servers
-::::::::::::
+************
Stand-alone WSGI servers typically use less resources than traditional web
-servers and provide top performance [3]_.
+servers and provide top performance [1]_.
.. _gunicorn-ref:
Gunicorn
--------
-`Gunicorn `_ (Green Unicorn) is a WSGI server used
-to serve Python applications. It is a Python interpretation of the Ruby
-`Unicorn `_ server. Unicorn is designed to be
-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 `_ (Green Unicorn) is a pure-Python WSGI
+server used to serve Python applications. Unlike other Python web servers,
+it has a thoughtful user interface, and is extremely easy to use and
+configure.
+
+Gunicorn has sane and reasonable defaults for configurations. However, some
+other servers, like uWSGI, are tremendously more customizable, and therefore,
+are much more difficult to effectively use.
+
+Gunicorn is the recommended choice for new Python web applications today.
+
+
+Waitress
+--------
+
+`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).
+
+Waitress is gaining popularity within the Python web development community.
.. _uwsgi-ref:
+uWSGI
+-----
+
+`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's web server support allows for dynamically configuring
+Python, passing environment variables, and further tuning. For full details,
+see `uWSGI magic
+variables `_.
+I do not recommend using uWSGI unless you know why you need it.
+
+.. _server-best-practices-ref:
+
+
+*********************
Server Best Practices
-:::::::::::::::::::::
+*********************
-The majority of self hosted Python applications today are hosted with a WSGI
+The majority of self-hosted Python applications today are hosted with a WSGI
server such as :ref:`Gunicorn `, either directly or behind a
lightweight web server such as :ref:`nginx `.
@@ -159,102 +252,57 @@ The WSGI servers serve the Python applications while the web server handles
tasks better suited for it such as static file serving, request routing, DDoS
protection, and basic authentication.
-Hosting
-:::::::
-Platform-as-a-Service
----------------------
+*******
+Hosting
+*******
Platform-as-a-Service (PaaS) is a type of cloud computing infrastructure
which abstracts and manages infrastructure, routing, and scaling of web
-applications. When using PaaS, application developers can focus on writing
+applications. When using a PaaS, application developers can focus on writing
application code rather than needing to be concerned with deployment
details.
-Most PaaS services offer a command-line interface that developers can use to
-set up and interrogate configuration, and to deploy new releases of an
-application to the service.
-
-PaaS services and their partners offer add-on functionality which is well
-integrated into the platform, such as database hosting, email services,
-logging, scheduled and background tasks, billing and payment, etc.
-
-
Heroku
-~~~~~~
-
-`Heroku `_'s
-`Cedar stack `_ offers first class
-support for Python 2.7 applications.
-
-Heroku allows you to run as many Python web applications as you like, 24/7 and
-free of charge. Heroku is best described as a horizontal scaling platform. They
-start to charge you once you "scale" your application to run on more than one
-Dyno (abstracted servers) at a time.
-
-Heroku publishes `step-by-step instructions
-`_ on how to set up your first
-application for use in Heroku, and maintains a list of `example applications
-`_.
-
-
-DotCloud
-~~~~~~~~
-
-`DotCloud `_ supports WSGI applications and
-background/worker tasks natively on their platform. Web applications run
-Python version 2.6, use :ref:`nginx ` and :ref:`uWSGI
-`, and allow custom configuration of both for advanced users.
-
-DotCloud uses a custom command-line API client which can work with
-applications managed in git repositories or any other version control
-system.
-
-DotCloud has a free plan with limited database size, and without extra
-services (caching…).
-
-See the `DotCloud documentation on Python
-`_ for more information and help
-getting started.
+------
+`Heroku `_ offers first-class support for
+Python 2.7–3.5 applications.
-Gondor
-~~~~~~
+Heroku supports all types of Python web applications, servers, and frameworks.
+Applications can be developed on Heroku for free. Once your application is
+ready for production, you can upgrade to a Hobby or Professional application.
-`Gondor `_ is a PaaS specialized for deploying Django
-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.
+Heroku maintains `detailed articles `_
+on using Python with Heroku, as well as `step-by-step instructions
+`_ on
+how to set up your first application.
-Gondor publishes guides to deploying `Django projects
-`_ and `Pinax projects
-`_ on their platform.
+Heroku is the recommended PaaS for deploying Python web applications today.
+**********
Templating
-::::::::::
-
-Most WSGI applications are responding to HTTP requests to serve
-content in HTML or other markup languages. Instead of generating directly
-textual content from Python, the concept of separation of concerns
-advises us to use templates. A template engine manages a suite of
-template files, with a system of hierarchy and inclusion to
-avoid unnecessary repetition, and is in charge of rendering
-(generating) the actual content, filling the static content
-of the templates with the dynamic content generated by the
-application.
+**********
+
+Most WSGI applications are responding to HTTP requests to serve content in HTML
+or other markup languages. Instead of directly generating textual content from
+Python, the concept of separation of concerns advises us to use templates. A
+template engine manages a suite of template files, with a system of hierarchy
+and inclusion to avoid unnecessary repetition, and is in charge of rendering
+(generating) the actual content, filling the static content of the templates
+with the dynamic content generated by the application.
As template files are
-sometimes written by designers or front-end developers,
-it can be difficult to handle increasing complexity.
+sometimes written by designers or front-end developers, it can be difficult to
+handle increasing complexity.
-Some general good practices apply to the part of the
-application passing dynamic content to the template engine,
-and to the templates themselves.
+Some general good practices apply to the part of the application passing
+dynamic content to the template engine, and to the templates themselves.
- Template files should be passed only the dynamic
content that is needed for rendering the template. Avoid
- to be tempted to pass additional content "just in case":
+ the temptation to pass additional content "just in case":
it is easier to add some missing variable when needed than to remove
a likely unused variable later.
@@ -262,15 +310,236 @@ and to the templates themselves.
or assignments in the template itself, and many
allow some Python code to be evaluated in the
templates. This convenience can lead to uncontrolled
- increase in complexity, and often harder to find bugs.
+ increase in complexity, and often make it 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.
+
+
+
+Jinja2
+------
+`Jinja2 `_ is a very well-regarded template engine.
+
+It uses a text-based template language and can thus be used to generate any
+type of markup, not just HTML. It allows customization of filters, tags, tests,
+and globals. It features many improvements over Django's templating system.
+
+Here some important HTML tags in Jinja2:
+
+.. code-block:: html
+
+ {# This is a comment #}
+
+ {# The next tag is a variable output: #}
+ {{title}}
+
+ {# Tag for a block, can be replaced through inheritance with other html code #}
+ {% block head %}
+
This is the head!
+ {% endblock %}
+
+ {# Output of an array as an iteration #}
+ {% for item in list %}
+
{{ item }}
+ {% endfor %}
+
+
+The next listings are an example of a web site in combination with the Tornado
+web server. Tornado is not very complicated to use.
+
+.. code-block:: python
+
+ # import Jinja2
+ from jinja2 import Environment, FileSystemLoader
+
+ # import Tornado
+ import tornado.ioloop
+ import tornado.web
+
+ # Load template file templates/site.html
+ TEMPLATE_FILE = "site.html"
+ templateLoader = FileSystemLoader( searchpath="templates/" )
+ templateEnv = Environment( loader=templateLoader )
+ template = templateEnv.get_template(TEMPLATE_FILE)
+
+ # List for famous movie rendering
+ movie_list = [[1,"The Hitchhiker's Guide to the Galaxy"],[2,"Back to future"],[3,"Matrix"]]
+
+ # template.render() returns a string which contains the rendered html
+ html_output = template.render(list=movie_list,
+ title="Here is my favorite movie list")
+
+ # Handler for main page
+ class MainHandler(tornado.web.RequestHandler):
+ def get(self):
+ # Returns rendered template string to the browser request
+ self.write(html_output)
+
+ # Assign handler to the server root (127.0.0.1:PORT/)
+ application = tornado.web.Application([
+ (r"/", MainHandler),
+ ])
+ PORT=8884
+ if __name__ == "__main__":
+ # Setup the server
+ application.listen(PORT)
+ tornado.ioloop.IOLoop.instance().start()
+
+The :file:`base.html` file can be used as base for all site pages which are
+for example implemented in the content block.
+
+.. code-block:: html
+
+
+
+
+
+
+ {{title}} - My Webpage
+
+
+
+ {# In the next line the content from the site.html template will be added #}
+ {% block content %}{% endblock %}
+
+
+
+
+
+The next listing is our site page (:file:`site.html`) loaded in the Python
+app which extends :file:`base.html`. The content block is automatically set
+into the corresponding block in the :file:`base.html` page.
+
+.. code-block:: html
+
+ {% extends "base.html" %}
+ {% block content %}
+
+
+
{{title}}
+
{{ list_title }}
+
+ {% for item in list %}
+
{{ item[0]}} : {{ item[1]}}
+ {% endfor %}
+
+
+
+ {% endblock %}
+
+
+Jinja2 is the recommended templating library for new Python web applications.
+
+Chameleon
+---------
+
+`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.
+
+Chameleon is available for Python 2.5 and up (including 3.x and PyPy), and
+is commonly used by the `Pyramid Framework `_.
+
+Page Templates add within your document structure special element attributes
+and text markup. Using a set of simple language constructs, you control the
+document flow, element repetition, text replacement, and translation. Because
+of the attribute-based syntax, unrendered page templates are valid HTML and can
+be viewed in a browser and even edited in WYSIWYG editors. This can make
+round-trip collaboration with designers and prototyping with static files in a
+browser easier.
+
+The basic TAL language is simple enough to grasp from an example:
+
+.. code-block:: html
+
+
+
+
Hello, World!
+
+
+
+
+
+
+
+
+
+
+
+The `` pattern for text insertion is common
+enough that if you do not require strict validity in your unrendered templates,
+you can replace it with a more terse and readable syntax that uses the pattern
+`${expression}`, as follows:
+
+.. code-block:: html
+
+
+
+
Hello, ${world}!
+
+
+
+ ${row.capitalize()} ${col}
+
+
+
+
+
+
+
+But keep in mind that the full `Default Text`
+syntax also allows for default content in the unrendered template.
+
+Being from the Pyramid world, Chameleon is not widely used.
+
+Mako
+----
+
+`Mako `_ is a template language that compiles to Python
+for maximum performance. Its syntax and API are borrowed from the best parts of other
+templating languages like Django and Jinja2 templates. It is the default template
+language included with the `Pylons and Pyramid `_ web
+frameworks.
+
+An example template in Mako looks like:
+
+.. code-block:: mako
+
+ <%inherit file="base.html"/>
+ <%
+ rows = [[v for v in range(0,10)] for row in range(0,10)]
+ %>
+
+ % for row in rows:
+ ${makerow(row)}
+ % endfor
+
+
+ <%def name="makerow(row)">
+
+ % for name in row:
+
${name}
\
+ % endfor
+
+ %def>
+
+To render a very basic template, you can do the following:
+
+.. code-block:: python
+
+ from mako.template import Template
+ print(Template("hello ${data}!").render(data="world"))
+
+Mako is well respected within the Python web community.
.. rubric:: References
-.. [1] `The mod_python project is now officially dead `_
-.. [2] `mod_wsgi vs mod_python `_
-.. [3] `Benchmark of Python WSGI Servers `_
+.. [1] `Benchmark of Python WSGI Servers `_
diff --git a/docs/scenarios/xml.rst b/docs/scenarios/xml.rst
index df89d580a..24dab5869 100644
--- a/docs/scenarios/xml.rst
+++ b/docs/scenarios/xml.rst
@@ -1,14 +1,20 @@
+
+###########
XML parsing
-===========
+###########
+
+.. image:: /_static/photos/33888714601_a1f7d020a2_k_d.jpg
+
+********
untangle
---------
+********
-`untangle `_ is a simple library which takes
-an XML document and returns a Python object which mirrors the nodes and
+`untangle `_ is a simple library which
+takes 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
@@ -24,11 +30,81 @@ can be loaded like this:
import untangle
obj = untangle.parse('path/to/file.xml')
-and then you can get the child elements name like this:
+and then you can get the child element's name attribute like this:
.. code-block:: python
obj.root.child['name']
-untangle also supports loading XML from a string or an URL.
+untangle also supports loading XML from a string or a URL.
+
+
+*********
+xmltodict
+*********
+
+`xmltodict `_ is another simple
+library that aims at making XML feel like working with JSON.
+
+An XML file like this:
+
+.. code-block:: xml
+
+
+
+
+
-
-
-
-
-
-
-
-
-{%- endblock %}
diff --git a/docs/_themes/kr/relations.html b/docs/_themes/kr/relations.html
deleted file mode 100644
index 3bbcde85b..000000000
--- a/docs/_themes/kr/relations.html
+++ /dev/null
@@ -1,19 +0,0 @@
-