Python: Coding Guidelines, Tools, Tests and Packages [2024]

Course Curriculum

Chapter 1: Chapter 1: Introduction and Software

Lecture 1: Introduction to the course

Lecture 2: Course manual

Lecture 3: Note: Materials and Software

Lecture 4: Setup the Python Environment

Lecture 5: Setup Visual Studio Code

Chapter 2: Chapter 2: Coding Guidelines and Docstrings

Lecture 1: PEP8 Coding Guidelines – Part 1

Lecture 2: PEP8 Coding Guidelines – Part 2

Lecture 3: Vscode Settings for the Tools

Lecture 4: Tool: isort

Lecture 5: Code Linter: Why do we need them?

Lecture 6: Code Linter: Flake8 and Pylint

Lecture 7: Code Linter: Ruff

Lecture 8: Formatter: Why do we need them?

Lecture 9: Formatter: Black

Lecture 10: Formatter: Ruff

Lecture 11: Example Class: Vector2D

Lecture 12: Docstring Styles

Lecture 13: Code Linter: Pydocstyle

Lecture 14: What is a Python Type Annotation? – Part 1

Lecture 15: What is a Python Type Annotation? – Part 2

Lecture 16: What is a Python Type Annotation? – Part 3

Lecture 17: Type Annotations: Union

Lecture 18: Type Annotations: Any and Optional

Lecture 19: Python 3.9 Type Annoations

Lecture 20: Type Annotation: List

Lecture 21: Type Annotation: Tuple

Lecture 22: Type Annotation: Callable

Lecture 23: Python 3.10 Type Annoations

Lecture 24: Type Annotation: Dict and Mapping

Lecture 25: Type Annotation: NoReturn

Lecture 26: Python 3.10 Type Annotations: TypeGuard

Lecture 27: Type Annotation: Protocol

Lecture 28: Type Annotation: Generic Functions

Lecture 29: Type Annotation: Generic Classes

Lecture 30: Type Annotations: NamedTuple and TypedDict

Lecture 31: Python 3.11 Type Annoations: Literals

Lecture 32: Python 3.12 Type Annoations

Lecture 33: pre-commit

Lecture 34: Config files for the tools

Lecture 35: Real World Example for the Tools

Chapter 3: Chapter 3: Debugging, Unit-Testing and Timing

Lecture 1: Debugging in VS Code: Python Part 1

Lecture 2: Debugging in VS Code: Python Part 2

Lecture 3: Debugging in VS Code: Jupyter Notebook

Lecture 4: Tasks in VS Code

Lecture 5: Timing

Lecture 6: Profiling

Lecture 7: Unit-Testing with unittest

Lecture 8: Unit-Testing with pytest

Chapter 4: Chapter 4: Packaging

Lecture 1: Modules and Packages – Part 1

Lecture 2: Modules and Packages – Part 2

Lecture 3: Modules and Packages – Part 3

Lecture 4: Modules and Packages – Part 4

Lecture 5: Overview for our Vector Python Package

Lecture 6: Metadata and Install the Library

Lecture 7: Mkdocs and Github Pages

Lecture 8: Pre-Commit Hooks

Lecture 9: More to Github Actions

Lecture 10: Code Coverage

Chapter 5: Chapter 5: Course conclusion

Lecture 1: Course conclusion

Lecture 2: Bonus Lecture