# 🪶 Our Python Styleguide
This styleguide exists to **make life easier, not harder.**
It captures the patterns that keep our codebase consistent, readable, and friendly for both humans and tools.
These are *preferences*, not commandments.
We value:
- 🧭 **Clarity over cleverness**
- 🔄 **Consistency over purity**
- 💬 **Empathy over elitism**
If your code is clear, maintainable, and works: you’re doing it right.
> 💡 Use these as reference points when you’re unsure how to format something.
> We won’t nitpick or gatekeep style. Our goal is harmony, not homogeneity.
---
## 📚 Index
| # | Topic |
|----|--------------------------------------------------|
| 1 | [Magic Literals](01_magic_literals.md) |
| 2 | [Dictionaries](02_dictionaries.md) |
| 3 | [Module Scope](03_module_scope.md) |
| 4 | [Variable Extraction](04_variable_extraction.md) |
| 5 | [Math Readability](05_math_readability.md) |
| 6 | [SOLID Principles](06_solid_principles.md) |
| 7 | [Shadowing](07_shadowing.md) |
| 8 | [Function Length](08_function_length.md) |
| 9 | [Namespacing](09_namespacing.md) |
| 10 | [Type Annotations](10_type_annotations.md) |
| 11 | [Docstrings](11_docstrings.md) |
| 12 | [Imports](12_imports.md) |
| 13 | [Mutable Defaults](13_mutable_defaults.md) |
| 14 | [Logging & Errors](14_logging_and_errors.md) |
| 15 | [Comprehensions](15_comprehensions.md) |
| 16 | [Aliasing](16_aliasing.md) |
---
### 🤝 Our Philosophy
We share these guidelines to make collaboration smoother, not to judge anyone’s intelligence or experience.
Every contributor brings their own style and background.
These docs simply provide a **common baseline** so our collective work feels coherent and approachable.
