README Header¶
osa_tool.operations.docs.readme_generation.generator.header
¶
HeaderBuilder
¶
build_information_section
property
¶
Builds the section with PyPi and license badges.
build_technology_section
property
¶
Builds the section with technology badges based on project dependencies.
build_header()
¶
Builds the full header section for the README file, combining the project name, information badges, and technology badges into a formatted string.
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
A formatted string representing the header section of the README. |
generate_info_badges()
¶
Generates PyPi-related badges: version and download stats.
generate_license_badge()
¶
Generates a license badge using Shields.io.
generate_tech_badges()
¶
Generates badges for technologies used in the project using available icons.
load_tech_icons()
¶
Loads technology icons from a JSON file.
load_template()
¶
Loads and parses the TOML template file.