Development
42 posts
Python Logging Best Practices for Library Developers
A comprehensive guide to implementing logging in Python libraries - from basic setup to advanced patterns and common pitfalls to avoid
Makefiles: The Unsung Hero of Python Development
Explore why Makefiles, though old-school, are invaluable for Python projects. Learn how they provide consistent, simple shortcuts for common dev tasks.
Modern Python Package Publishing: PyGeoHash's New CI/CD Pipeline
PyGeoHash uses GitHub Actions, cibuildwheel, and PyPI's Trusted Publisher for automated, secure multi-platform Python package builds and publishing.
PyGeoHash Gets Type Hints: A Journey into Modern Python
Enhance PyGeoHash with comprehensive type hints and a new types module, improving developer experience and code quality for modern Python.
Documenting Your Library's API: Best Practices
Build a clear, comprehensive API reference with Sphinx & autodoc. Learn best practices for structure, content, cross-referencing your Python library docs.
Automating Docs Deployment with GitHub Actions and Pages
Keep docs current automatically! Learn to set up GitHub Actions to build Sphinx docs & deploy to GitHub Pages, ensuring sync with your code changes.
Crafting Code Examples: From Snippets to Real-World Scenarios
Master the art of crafting clear, runnable code examples for documentation using doctest, tutorials, and scripts to enhance user understanding.
Getting Started with Sphinx for Python Project Documentation
Learn how to use Sphinx to generate professional, cross-referenced documentation for your Python projects, covering installation, configuration, and autodoc.
The Art of Leadership Communication: Building Trust and Alignment
How effective leaders build trust and create alignment through strategic communication, drawing from military leadership principles
Effective Docstrings: Google vs. NumPy vs. reStructuredText Styles
Learn to write clear docstrings Sphinx understands. Compares Google, NumPy, and reStructuredText formats for effective Python library documentation.