Skip to content

SaraFreitas-dev/42-Python-Documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

26 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ 42 School Python Documentation & Project Notes

Documentation Made with MkDocs 42 School

Beginner-friendly Python documentation and notes created during the 42 School Common Core journey.

๐ŸŒ Interactive Documentation Website:
https://sarafreitas-dev.github.io/42-Python-Documentation/

This repository contains practical guides, examples, workflows, and explanations about important Python concepts frequently used in modern development and 42 projects.

The documentation website was built using MkDocs and Material for MkDocs.

It will be continuously expanded with new documentation, workflows, project notes, and debugging references.


๐Ÿ“š Repository Overview

PYTHON_42_SCHOOL_DOCUMENTATION/
โ”‚
โ”œโ”€โ”€ โš™๏ธ Flake8_&_Mypy
โ”œโ”€โ”€ ๐ŸŒฟ Git
โ”œโ”€โ”€ ๐Ÿ› ๏ธ Makefile
โ”œโ”€โ”€ ๐ŸŽฎ MLX-42lib
โ”œโ”€โ”€ ๐Ÿš€ Projects
โ””โ”€โ”€ ๐Ÿ Python_core  # With concepts including Packages, OOP,class methods, etc.

The repository contains multiple sections dedicated to Python core concepts, development tooling, MLX-related notes, and project documentation designed to support and explain newer 42 School Python projects.


๐Ÿ“– Included Topics

๐ŸŽฎ MLX & Graphics

  • MLX-related notes
  • graphics workflows
  • rendering concepts

๐Ÿš€ Projects

Project-related notes and documentation created to help understand and complete newer Python projects from the 42 curriculum. This sections may include implementation notes, architecture explanations, debugging workflows, and development utilities.

Additional project documentation may continue to be added over time.


๐Ÿ Python Core

  • typing
  • OOP
  • Pydantic
  • JSON validation
  • virtual environments
  • error handling
  • Packages

๐Ÿ› ๏ธ Makefiles

  • Python Makefiles
  • virtual environments
  • automation workflows
  • linting commands

โš™๏ธ Flake8 & Mypy

  • type checking
  • linting
  • formatting
  • common errors

๐ŸŒฟ Git

  • branches
  • merge
  • stash
  • reset
  • GitHub workflows

๐Ÿง  Purpose

This repository was created to:

  • centralize useful Python knowledge
  • simplify difficult concepts
  • provide beginner-friendly examples
  • document useful workflows and tooling
  • support future 42 Python projects

๐Ÿ“Œ Notes

  • Most documentation is beginner-friendly
  • Examples focus on practical usage
  • Topics are organized by category
  • New documentation may continue to be added over time

๐Ÿ 42 School โ€” Python Documentation Repository

Built during the 42 Common Core journey.

About

๐Ÿ“š 42 School Python documentation repository with guides about typing, OOP, Git, Pydantic, JSON validation, virtual environments, mypy, flake8, parsing systems, as well as notes and workflows used in real 42 School projects.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors