20 docs tagged with "clean-code"

Why code quality is an engineering concern, not an aesthetic one - covering the mindset shift from code that runs to code that lasts.

Design and build professional Python command-line interfaces with argparse and Click - with proper help text, exit codes, stdin/stdout conventions, and composable commands.

Learn to identify the 15 most common code smells in Python code - the warning signs that indicate deeper design problems - and the refactoring that fixes each one.

Learn to write docstrings that actually help engineers - covering Google, NumPy, and Sphinx styles, when to document vs when to improve the code, and how to generate API docs automatically.

Use Black, isort, flake8, mypy, and pre-commit hooks to enforce code quality automatically - so engineers focus on logic, not formatting debates.

Names are the primary documentation. Learn how to name variables, functions, classes, modules, and constants so that code communicates intent without comments.

Master PEP 8 at engineering depth - not as a list of rules to memorize, but as a system of constraints that reduces cognitive load and enables collaboration at scale.

Learn how to structure Python projects for maintainability - from scripts to packages to full applications - using src layout, pyproject.toml, and clear module boundaries.

Solve 11 Python cli design principles problems. Covers argparse practice, sys.argv exercises, CLI exit. Hints and solutions.

Solve 11 Python code smells problems. Covers refactoring exercises, long function, magic numbers. Hints and solutions.

Solve 11 Python docstrings and documentation problems. Covers docstrings practice, google style, numpy docstrings. Hints and solutions.

Solve 11 Python formatting and tooling problems. Covers black formatter, isort python, flake8 error, mypy type. Hints and solutions.

Solve 11 Python naming conventions problems. Covers snake_case exercises, PascalCase python. Hints and solutions.

Solve 11 Python pep8 and style problems. Covers pep8 practice, flake8 exercises, style guide. Hints and solutions.

Solve 11 Python project structure problems. Covers src layout, pyproject.toml practice, __init__.py python. Hints and solutions.

Solve 11 Python refactoring techniques problems. Covers refactoring practice, extract function, replace magic. Hints and solutions.

Solve 11 Python version control basics problems. Covers git workflow, gitignore python, conventional commits. Hints and solutions.

Learn systematic refactoring techniques with Python examples - how to restructure code safely, when to refactor vs rewrite, and how to keep tests green throughout.

Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, and Dependency Inversion - applied to production Python.

Learn the Git workflows, commit conventions, branching strategies, and Python-specific practices that professional engineering teams use daily.