Further reading
Here you can find the relevant references used in the sections, and some additional resources.
Setting Up
Python - Creation of virtual environments
GitHub - Introduction to GitHub
GitHub - GitHub Student Developer Pack
Microsoft - Introduction to Git
Microsoft - Getting started with Visual Studio Code
Microsoft - Python in Visual Studio Code
Microsoft - Using Git source control in VS Code
Microsoft - Working with GitHub in VS Code
Project overview
Scikit Learn - Documentation - this is seriously the gold standard of machine learning software documentation. It contains not only excellent functional documentation but also a user guide to the methods, techniques, and algorithms used. Highly recommend.
Scikit Learn - Wisconsin breast cancer dataset
Typer - User guide introduction
argparse - Parser for CL options, arguments and sub-commands
Poetry
Poetry - The pyproject.toml
file
Python Packaging - Writing you pyproject.toml
GitHub - Choose an open source license
Testing
Python - unittest
- Unit testing framework
Microsoft - Python testing in Visual Studio Code
Publishing
Python - Python packing user guide
Python - Packaging Python projects
Documentation
Python - PEP 8 - Style guide for Python code
Python - PEP 20 - The Zen of Python
Python - PEP 257 - Docstring conventions
MkDocs - Getting started with MkDocs
Material for MkDocs - Getting started
Read the Docs - Read the Docs tutorial
CI/CD - Pre-commit
GitHub - GitHub Actions documentation
Isort - Installing and using isort
CI/CD - Testing
CI/CD - Publishing
GitHub - Collaborating with pull requests