How carlbordum/manly works
Project Components
• Command Line Interface (CLI): Since manly is invoked from the terminal, this is the primary entry point.
• Main Module (manly.py): The core component which parses user arguments, calls external commands, and processes and displays man page information.
• External Dependency – “man” Command: manly acts as a front-end for the traditional man pages, so there is an implicit dependency on the system’s man command.
• Testing Suite: Represent the test module (test_manly.py) used for validation/testing of the functionality.
• Build/Configuration Files: Although not directly part of runtime architecture, components like pyproject.toml, .travis.yml, and .gitignore indicate build, deployment, and code standards.
Out Component Interactions
• Flow of processed/augmented information back to the User Terminal for display.
• Optionally, include a block for “Testing” that interacts with manly.py to validate functionality, symbolizing quality assurance via pytest (as discussed in the README).
Architectural Patterns & Design Principles
• It uses a “wrapper” or “adapter” pattern in that it wraps around the system’s classic man command to enhance its output.
Relevant Technologies
• Python (compatible with both Python 2 and 3)
• pytest for tests
• Standard libraries (such as subprocess for calling external commands)
• External man utility running on the system