# Lesson Plans

Document Release Date: 1/2/2024

Note: In the I.T. world, applications evolve rapidly. Please report any inaccuracy to papabearcodespython@gmail.com

---

Current

Document Only

• Pyenv Purpose and Installation
• Pyenv Usage: Command Line
• Pyenv Usage: Makefile

Future

These are high level lesson plans we are planning on implementing.

• VsCode

  • Why?
    • Stats (https://www.lambdatest.com/blog/best-vs-code-extensions/)
    • Advantages
      • Highly Customizable (Extension)
      • Light weight
      • Popular + lots of community support
      • Write your own extension
    • Negatives
      • It Caches (Reload when strange things happen)
      • Batteries not included
  • Download + Updates
  • Basic stuff
    • Extensions
    • Files & Folders - Workspaces
    • .vscode/settings.json
      • Editor settings

• Proper Python Project Folder Structure

  • src
  • tests
  • Other files: License, Changelog, readme.md

• Pyproject.toml

  • Extensions
    • Even better toml (tamasfe.even-better-toml)
  • toml (Tom's obvious minimal language) https://toml.io/en/
  • Make it a package
  • Requirements
  • Formatters
    • Black
      • Extension (ms-python.black-formatter)
      • .vscode/settings.json
  • Linting
    • Pylint
      • Extension (ms-python.pylint)
    • Mypy
    • Pylance (PyRight)
      • Extension (ms-python.vscode-pylance)
      • Pypi + Pyproject.toml
    • PyDocstyle (Sphynx Annotation)
  • Plug-in Auto documentation
  • Testing

• todo

  • Extensions
    • wayou.vscode-todo-highlight
    • Todo Tree (Gruntfuggly.todo-tree)

• Vscode

  • Common Extensions
    • Python (ms-python.python)
    • reload vscode (natqe.reload)
    • Open with html browser (peakchen90.open-html-in-browser)
    • Great icons (emmanuelbeziat.vscode-great-icons)
  • Virtual Environment
    • Plugin (donjayamanne.python-environment-manager)
    • Setting in VSCode
    • Custom .vscode/Settings.json

• Python

  • Extensions
    • almenon.arepl

• DevContainer Development

  • ms-vscode-remote.remote-containers
  • ms-vscode-remote.remote-wsl

• Github

  • Extension
    • Github actions (github.vscode-github-actions)
    • mhutchie.git-graph
    • Git commit workflow (vivaxy.vscode-conventional-commits)

• git

  • extensions
    • waderyan.gitblame
    • donjayamanne.githistory

• Sphynx

  • Extension
    • njpwerner.autodocstring
    • leonhard-s.python-sphinx-highlight

• Jypiter Notebooks

  • Extension
  • Setup

• code together

  • extensions
    • ms-vsliveshare.vsliveshare
    • genuitecllc.codetogether

• python depencies