Skip to content

Instantly share code, notes, and snippets.

View Julynx's full-sized avatar
🏠
Working from home

Julio Cabria Julynx

🏠
Working from home
View GitHub Profile
@Julynx
Julynx / last_python_style_guide.md
Created July 8, 2025 18:15
The last Python style guide you'll ever need

When writing Python code, make sure you follow these guidelines strictly to ensure mantainability and production-readiness:

  1. Use descriptive variable names. Choose full english words over abbreviations or generic terms.

  2. Write function and module docstrings. After every set of changes, use a formatter like black, then a linter like pylint to check for errors and warnings. Correct all of them without bypassing anything until you achieve a perfect 10/10 score.

  3. Include extensive error handling. Use exceptions for unexpected outcomes and return values for expected outcomes. Use a proper logging module to log any errors and their tracebacks to a log file, not just the console.

  4. A function should do one thing and one thing only. Functions should be semantically organized into modules, neatly grouped inside descriptively named directories, and not just sit in the root directory.

@Julynx
Julynx / 15_python_tips.md
Last active February 27, 2025 16:06
15 Python Tips To Take Your Code To The Next Level!