python.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Mon, 22 Feb 2016 12:46:36 +0200
changeset 1905 fba288d59662
parent 1369 06b695810e88
child 1912 8b81a8f0f692
permissions -rw-r--r--
Include only local subsections into TOC. This prevent duplication of TOC when build single page HTML document. Also this make unnecessary CSS hack to hide document title as top level section.

.. -*- coding: utf-8; -*-
.. include:: HEADER.rst

========
 Python
========
.. contents::
   :local:

Licence and history of Python.
==============================

  http://docs.python.org/dev/license.htm

Byte compile .py and check for errors.
======================================
::

  $ python -m compileall $dir

Install python modules/packages.
================================

  http://wiki.python.org/moin/CheeseShopTutorial
                Installing Distributions from the Python Package Index (Start Here)

Uninstall python modules.
=========================

Install again and save list of installed files::

  $ python setup.py install --record files.txt
  $ rm `cat files.txt`

  http://peak.telecommunity.com/DevCenter/EasyInstall#uninstalling-packages
                Uninstalling Packages

Generate documentation from Python sources.
===========================================

Generate documentation from Python sources by pydoc.
----------------------------------------------------
::

  $ mkdir html
  $ cd html
  $ pydoc -w ../

Generate documentation from Python sources by epydoc.
-----------------------------------------------------

Generate documentation from Python sources by Sphinx.
-----------------------------------------------------
::

  $ sudo apt-get install python-sphinx
  $ sudo apt-get install rst2pdf

Code analyzers and style checkers.
==================================

Pylint.
-------

  http://www.logilab.org/857
  http://pypi.python.org/pypi/pylint

PyChecker.
----------

  http://pychecker.sourceforge.net/

Debugging Python code.
======================

Pretty print under Python.
--------------------------
::

  import pprint
  print(pprint.pformat('string'))
  print(pprint.pformat(['1', '2']))

See:

  http://docs.python.org/library/pprint.html
                Doc page.

Trace Python execution.
=======================

  http://python-ptrace.hachoir.org/trac
                python-ptrace by Victor Stinner
  http://subterfugue.org/
                subterfugue