.. index::
   pair: RTD; Python Guide

.. _python_guide:

=============================
Python Guide
=============================

.. seealso::

   - https://github.com/kennethreitz/python-guide

.. contents::
   :depth: 3


Hitchhiker's Guide to Python
============================

**Python Best Practices Guidebook**

**Work in progress. If you'd like to help, please do.
There's a lot of work to be done.**

This guide is currently under heavy development. 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.


Topics include:

- Platform/version specific installations
- Py2app, Py2exe, bbfreeze, pyInstaller
- Pip / virtualenv
- Documentation. Writing it.
- server configurations / tools for various web frameworks
- fabric
- exhaustive module recommendations, grouped by topic/purpose
- Testing. Jenkins + tox guides.
- How to interface w/ hg from git easily
- what libraries to use for what

If you are not fond of reading reStructuredText, there is an
almost up-to-date `HTML version at docs.python-guide.org
<http://docs.python-guide.org>`_.

.. _python_guide_theme:

Python guide Sphinx theme (kr)
================================

.. seealso::

   - https://github.com/kennethreitz/python-guide/blob/master/docs/conf.py
   - http://docs.python-guide.org/en/latest/
   - :ref:`kr_theme`