Merge pull request #1 from realpython/master

Update the real python

Author: manojk16

docs/_templates/sidebarintro.html

@@ -59,8 +59,8 @@ <h3>Contributors</h3>
 <h3>Useful Links</h3>
 <ul>
   <li><a href="https://docs.python-guide.org/">The Guide Website</a></li>
-  <li><a href="http://github.com/realpython/python-guide">The Guide @ GitHub</a></li>
-  <li><a href="http://github.com/realpython/python-guide/issues">Issue Tracker</a></li>
+  <li><a href="https://github.com/realpython/python-guide">The Guide @ GitHub</a></li>
+  <li><a href="https://github.com/realpython/python-guide/issues">Issue Tracker</a></li>
   <li><a href="https://media.readthedocs.org/pdf/python-guide/latest/python-guide.pdf">The Guide as a PDF</a></li>
 </ul>
 
@@ -69,8 +69,8 @@ <h3>Translations</h3>
   <li><a href="https://docs.python-guide.org/">English</a></li>
   <li><a href="https://python-guide-fr.readthedocs.io/fr/latest/">French</a></li>
   <li><a href="https://pythonguidecn.readthedocs.io/zh/latest/">Chinese</a></li>
-  <li><a href="http://python-guideja.readthedocs.io/ja/latest/">Japanese</a></li>
+  <li><a href="https://python-guideja.readthedocs.io/ja/latest/">Japanese</a></li>
   <li><a href="https://python-guide-kr.readthedocs.io/ko/latest/">Korean</a></li>
-  <li><a href="http://python-guide-fil.readthedocs.io/en/latest/">Filipino</a></li>
-  <li><a href="http://python-guide-pt-br.readthedocs.io/pt_BR/latest/">Brazilian Portuguese</a></li>
+  <li><a href="https://python-guide-fil.readthedocs.io/en/latest/">Filipino</a></li>
+  <li><a href="https://python-guide-pt-br.readthedocs.io/pt_BR/latest/">Brazilian Portuguese</a></li>
 </ul>

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'2011–2018 <a href="http://kennethreitz.com/pages/open-projects.html">Kenneth Reitz</a> &amp; <a href="https://realpython.com">Real Python</a>. <a href="http://creativecommons.org/licenses/by-nc-sa/3.0/">CC BY-NC-SA 3.0</a>'
+copyright = (u'2011-{} <a href="http://kennethreitz.com/pages/open-projects.html">Kenneth Reitz</a>'
+             ' &amp; <a href="https://realpython.com">Real Python</a>.'
+             ' <a href="http://creativecommons.org/licenses/by-nc-sa/3.0/">CC BY-NC-SA 3.0</a>').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
@@ -241,7 +246,7 @@
 epub_title = u'pythonguide'
 epub_author = u'Kenneth Reitz'
 epub_publisher = u'Kenneth Reitz'
-epub_copyright = u'2011–2018, Kenneth Reitz & Real Python'
+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.

docs/dev/env.rst

@@ -87,10 +87,10 @@ using ``<Tab>`` 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/
-.. _pycodestyle: https://pypi.python.org/pypi/pycodestyle/
-.. _syntastic: https://github.com/scrooloose/syntastic
-.. _Python-mode: https://github.com/klen/python-mode
+.. _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
 
@@ -103,7 +103,7 @@ Emacs user is `Python Programming in Emacs`_ at EmacsWiki.
 
 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
 --------
@@ -135,7 +135,7 @@ Atom
 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 <https://github.com/AtomLinter/Linter>`_ combined with
+`Linter <https://github.com/steelbrain/linter>`_ combined with
 `linter-flake8 <https://github.com/AtomLinter/linter-flake8>`_.
 
 
@@ -163,21 +163,21 @@ MIT licensed.
 
 Enthought Canopy
 ----------------
-`Enthought Canopy <https://www.enthought.com/products/canopy/>`_ is a Python
+`Enthought Canopy <https://www.enthought.com/product/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 <http://pydev.org>`_.
+`PyDev <https://pydev.org>`_.
 
 
 Komodo IDE
 ----------
 
-`Komodo IDE <http://www.activestate.com/komodo-ide>`_ is developed by
+`Komodo IDE <https://www.activestate.com/products/komodo-ide/>`_ is developed by
 ActiveState and is a commercial IDE for Windows, Mac, and Linux.
 `KomodoEdit <https://github.com/Komodo/KomodoEdit>`_ is the open source
 alternative.
@@ -188,8 +188,8 @@ Spyder
 
 `Spyder <https://github.com/spyder-ide/spyder>`_ is an IDE specifically geared
 toward working with scientific Python libraries (namely
-`SciPy <http://www.scipy.org/>`_). It includes integration with pyflakes_,
-`pylint <http://www.logilab.org/857>`_ and
+`SciPy <https://www.scipy.org/>`_). It includes integration with pyflakes_,
+`pylint <https://www.logilab.org/857>`_ and
 `rope <https://github.com/python-rope/rope>`_.
 
 Spyder is open source (free), offers code completion, syntax highlighting,
@@ -242,13 +242,13 @@ 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.
 
 To start using and see more information:
-`Virtual Environments <http://github.com/kennethreitz/python-guide/blob/master/docs/dev/virtualenvs.rst>`_ docs.
+`Virtual Environments <https://github.com/kennethreitz/python-guide/blob/master/docs/dev/virtualenvs.rst>`_ docs.
 
 
 pyenv
 -----
 
-`pyenv <https://github.com/yyuu/pyenv>`_ is a tool to allow multiple versions
+`pyenv <https://github.com/pyenv/pyenv-virtualenv>`_ 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
@@ -264,7 +264,7 @@ 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 <https://github.com/yyuu/pyenv-virtualenv>`_ which automates
+`pyenv-virtualenv <https://github.com/pyenv/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.
@@ -314,7 +314,7 @@ To download and install IPython with all its optional dependencies for the noteb
 BPython
 -------
 
-`bpython <http://bpython-interpreter.org/>`_ is an alternative interface to the
+`bpython <https://bpython-interpreter.org/>`_ is an alternative interface to the
 Python interpreter for Unix-like operating systems. It has the following
 features:
 
@@ -334,8 +334,8 @@ features:
 ptpython
 --------
 
-`ptpython <https://github.com/jonathanslenders/ptpython/>`_ is a REPL build
-on top of the `prompt_toolkit <http://github.com/jonathanslenders/python-prompt-toolkit>`_
+`ptpython <https://github.com/prompt-toolkit/ptpython>`_ is a REPL build
+on top of the `prompt_toolkit <https://github.com/prompt-toolkit/python-prompt-toolkit>`_
 library. It is considered to be an alternative to BPython_. Features include:
 
 * Syntax highlighting

docs/dev/virtualenvs.rst

@@ -118,7 +118,7 @@ tutorial) and run:
 
 .. code-block:: console
 
-    $ cd myproject
+    $ cd project_folder
     $ pipenv install requests
 
 Pipenv will install the excellent `Requests`_ library and create a ``Pipfile``
@@ -156,7 +156,7 @@ when you share your project with others. You should get output similar to this
     Adding requests to Pipfile's [packages]...
     P.S. You have excellent taste! ✨ 🍰 ✨
 
-.. _Requests: https://python-requests.org
+.. _Requests: http://docs.python-requests.org/en/master/
 
 
 Using installed packages
@@ -200,7 +200,7 @@ Congratulations, you now know how to install and use Python packages! ✨ 🍰 
 Lower level: virtualenv
 =======================
 
-`virtualenv <http://pypi.python.org/pypi/virtualenv>`_ is a tool to create
+`virtualenv <http://pypi.org/project/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.
 
@@ -225,7 +225,7 @@ Basic Usage
 
 .. code-block:: console
 
-   $ cd my_project_folder
+   $ cd project_folder
    $ virtualenv venv
 
 ``virtualenv venv`` will create a folder in the current directory which will
@@ -260,19 +260,19 @@ or change the interpreter globally with an env variable in ``~/.bashrc``:
    $ 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
+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, same command which is mentioned in step 1 can be used for creation of virtual environment. But, to activate, we use the following command.
+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 project directory:
+Assuming that you are in your project directory:
 
-.. code-block:: powershell
+.. code-block:: console
 
-   PS C:\Users\suryav> \venv\Scripts\activate
+    C:\Users\SomeUser\project_folder> venv\Scripts\activate
 
-Install packages as usual, for example:
+Install packages using the ``pip`` command:
 
 .. code-block:: console
 
@@ -283,13 +283,13 @@ Install packages as usual, for example:
 
 .. 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. (In this case,
-it would be ``rm -rf my_project``.)
+it would be ``rm -rf project_folder``.)
 
 After a while, though, you might end up with a lot of virtual environments
 littered across your system, and it's possible you'll forget their names or
@@ -366,23 +366,23 @@ Basic Usage
 
 .. code-block:: console
 
-   $ mkvirtualenv my_project
+   $ mkvirtualenv project_folder
 
-This creates the :file:`my_project` folder inside :file:`~/Envs`.
+This creates the :file:`project_folder` folder inside :file:`~/Envs`.
 
 2. Work on a virtual environment:
 
 .. code-block:: console
 
-   $ workon my_project
+   $ 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 myproject``.
+when you ``workon project_folder``.
 
 .. code-block:: console
 
-   $ mkproject myproject
+   $ 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

docs/intro/duction.rst

@@ -28,11 +28,11 @@ include:
   object serialization, and much more.
 
   Additionally, the
-  `Python Package Index <http://pypi.python.org/pypi/>`_ is available
+  `Python Package Index <https://pypi.org>`_ is available
   for users to submit their packages for widespread use, similar to
-  Perl's `CPAN <http://www.cpan.org>`_. There is a thriving community
+  Perl's `CPAN <https://www.cpan.org>`_. There is a thriving community
   of very powerful Python frameworks and tools like
-  the `Django <http://www.djangoproject.com>`_ web framework and the
+  the `Django <https://www.djangoproject.com>`_ web framework and the
   `NumPy <http://numpy.scipy.org>`_ set of math routines.
 
 * **integration with other systems**