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:

  • Python Project Structure
  • Generate Code Documentation
  • Project Documentation Matters
  • Use setup.py from the Start
  • Great Software has Great Logging
  • Best Practice for __main__ method

reStructuredtext (rst)

  • reStructuredText Cheat Sheet
  • reStructuredText Sample of Stylings

Code Documentation

  • py_guide code doc
    • py_guide package
    • py_guide.py_template package
    • setup module
  • README

Being Pythonic

  • Python Package Index
  • Tips and Tricks
  • Acknowledgements
  • There’s no shame in Windows
Python Guide for Practicing Wizards
  • Docs »
  • py_guide code doc
  • View page source

py_guide code doc¶

  • py_guide package
    • Module contents
    • Submodules
      • py_guide.console_menu module
      • py_guide.log_4_trees module
      • py_guide.project_factory module
  • py_guide.py_template package
    • Module contents
  • setup module
Next Previous

© Copyright 2019, Shawn J Burke

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