Maintenance: Complete Docs, Tests, and Finalized CLI for Currency Script #457
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.
Maintenance: Complete Docs, Tests, and Finalized CLI for Currency Script
[MAINTENANCE] Currency Script | Expand Test Coverage, Add CLI (main.py), and Improve Docs #433
Summary
This PR performs essential maintenance tasks to ensure the currency converter script is documented, testable, and complete for use via a CLI entry point (main.py).
Description
This update focuses on project hygiene and completeness, without modifying or refactoring any core logic. The goal was to tidy up the structure, add missing elements, and prepare the project for practical use or future extension.
The changes are as follows:
Completed docstrings across all modules:
Added unit tests for:
Finalized main.py to act as a CLI interface for converting currencies interactively
Updated requirements.txt for dependency installation (only requests)
Updated a simple README.txt to explain setup and usage
Updated setup.py for packaging (basic scaffolding only)
Checks
in the repository
in the PR
Thank You,
Sue