Identify and prioritize backlog tech debt#4
Merged
PhilipMathieu merged 6 commits intomainfrom Nov 16, 2025
Merged
Conversation
This commit addresses three critical technical debt items: 1. Add .env.example file - Created comprehensive environment variable documentation - Includes CENSUS_API_KEY setup instructions with signup URL - Helps with onboarding and configuration management 2. Fix empty except blocks with proper error handling - Added logging to previously silent error handlers in changelog.py - Added logging to network/parsing errors in probe_data_sources.py - Errors are now visible for debugging instead of being silently ignored - Added logging import to probe_data_sources.py 3. Replace print() with proper logging - Replaced all print() statements with appropriate logging levels - Added logging configuration to convert_to_pmtiles.py, download_graphs.py - Added logging import to h3utils.py - Errors use logging.error(), warnings use logging.warning(), info uses logging.info() - Improves debuggability and allows for log level control These improvements enhance code maintainability, debuggability, and user experience.
Following code review feedback, updated logging implementation to match established patterns and ensure future maintainability: 1. Library modules (h3utils.py): - Use logger = logging.getLogger(__name__) pattern - Removed basicConfig() which shouldn't be in imported modules - Changed logging.info() to logger.info() calls 2. Entry point scripts (convert_to_pmtiles.py, download_graphs.py): - Added explicit handlers=[logging.StreamHandler()] to basicConfig - Use logger = logging.getLogger(__name__) + logger.info() pattern - Consistent with run_pipeline.py and update_data_sources.py format 3. Added DEVELOPMENT.md documentation: - Clear guidelines for when to use basicConfig vs getLogger - Examples showing proper patterns for library vs entry scripts - Integration guidance for TQDM progress bars - Error handling best practices - Helps future developers use logging correctly These changes ensure: - No conflicts when modules are imported - Consistent logging format across the codebase - Proper integration with TQDM progress bars - Clear documentation for future contributors
|
…UBbdhY # Conflicts: # src/probe_data_sources.py
📦 PR Preview BuiltThe site has been built and is available as a downloadable artifact in this workflow run. To preview locally:
Or wait for this PR to be merged to see it live on GitHub Pages. |
PhilipMathieu
deleted the
claude/identify-tech-debt-01HdoKFmWEh4XccDBLUBbdhY
branch
PhilipMathieu
restored the
claude/identify-tech-debt-01HdoKFmWEh4XccDBLUBbdhY
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.