Learn_Python_Coding_Guidelines

Personal Notes on Python Coding Guidelines, Tooling, Unit Testing and Packages

These notes were taken as part of a Udemy course I completed.

Python Coding Guidelines, Tooling, Unit Testing and Packages

• Course: https://www.udemy.com/course/python-coding-guidelines-tooling-testing-and-packaging/

TOC (I will add the links later):

Intro

PAGE 1

1. Make a virtual enviorment
2. Setup visual studio code

Coding Guidelines and Docstrings

PAGE 1

1. PEP 8 Coding Guidelines - Part 1
2. PEP 8 Coding Guidelines - Part 2
3. Code Linter - Pylint - Part 1
4. Code Linter - Pylint - Part 2
5. Code Linter - Flake8
6. Tool - isort
7. Formater - Autopep8
8. Formater - Black
9. Docstring - Numpy Style
10. Docstring - ReST (Sphinx)
11. Docstring - Google style
12. Code linter - Pydocstyle
13. Type Annotations and Mypy - Part 1
14. Type Annotations and Mypy - Part 2
15. Type Annotations and Mypy - Part 3
16. Config files for the tools
17. Setup the tools in vscode

Debugging, Unit-Testing and Timing

PAGE 1

1. Debugging in VS Code
2. Timing
3. Profiling
4. Unit-Testing

Packaging

PAGE 1

1. Debugging in VS Code
2. Modules and Packages - Part 1
3. Modules and Packages - Part 2
4. Creating a Package for an Example Vector Class
5. HTML Documentation with Mkdocs
6. Install Make and Git
7. Github Repository and GitHub Pages
8. Makefile and Requirements
9. More to Unit-Tests
10. Python Test Explorer
11. Code Coverage
12. GitHub WorkFlows and Pre-Commit