Python Guide for Practicing Wizards
0.2.5
  • Too Long; Didn’t Read (TL;DR)

Getting Started

  • Step 1: Install Python
  • Step 2: Install PyCharm
  • Step 3: Install sjb.pyguide
  • Step 4: Generate Project

Best Practices:

  • Why Py Guide Generator?
  • Python Project Structure
  • Generate Code Documentation
  • Project Documentation Matters
  • Use setup.py from the Start
  • Great Software has Great Logging
  • Routing Pattern for __main__()

reStructuredtext (rst)

  • reStructuredText Cheat Sheet
  • reStructuredText Sample of Stylings

Code Documentation

  • py_guide code doc
  • README

Being Pythonic

  • Python Package Index
  • Tips and Tricks
  • Acknowledgements
  • There’s no shame in Windows
Python Guide for Practicing Wizards
  • Docs »
  • Overview: module code

All modules for which code is available

  • py_guide.__main__
  • py_guide.console_menu
  • py_guide.logging_trees
  • py_guide.project_factory
  • setup

© Copyright 2019, Shawn J Burke

Built with Sphinx using a theme provided by Read the Docs.