Skip to content

Commit

Permalink
testing 16
Browse files Browse the repository at this point in the history
  • Loading branch information
@asucrews
asucrews authored Jul 3, 2024
1 parent 3305587 commit 5a63e65
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 70 deletions.
2 changes: 1 addition & 1 deletion automations/binary_sensor_notifications_plus/binary_sensor_notifications_plus.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,4 +175,4 @@ action:
entity_id: !input left_open_timer_helper

mode: single
max_exceeded: silent
max_exceeded: silent
3 changes: 1 addition & 2 deletions automations/car_tag/car_tag.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,5 +163,4 @@ action:
entity_id: !input garage_door_timer_helper

mode: single
max_exceeded: silent

max_exceeded: silent
145 changes: 78 additions & 67 deletions scripts/yaml_to_markdown.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,83 +10,94 @@ def construct_ignore(loader, node):
yaml.add_constructor('!input', construct_ignore, Loader=yaml.SafeLoader)

def yaml_to_markdown(yaml_file, markdown_file):
with open(yaml_file, 'r') as f:
data = yaml.safe_load(f)

try:
with open(yaml_file, 'r') as f:
data = yaml.safe_load(f)
except yaml.YAMLError as exc:
print(f"Error parsing YAML file {yaml_file}: {exc}")
return

if not isinstance(data, dict):
print(f"Error: Parsed YAML data is not a dictionary in file {yaml_file}")
return

if 'blueprint' not in data:
print(f"Skipping {yaml_file}: 'blueprint' key not found.")
return

with open(markdown_file, 'w') as f:
f.write(f"# {data['blueprint'].get('name', 'Unnamed Blueprint')}\n\n")
f.write(f"## Description\n{data['blueprint'].get('description', 'No description')}\n\n")
f.write(f"## Source\n[{data['blueprint'].get('source_url', 'No source URL')}]({data['blueprint'].get('source_url', 'No source URL')})\n\n")
f.write(f"## Domain\n{data['blueprint'].get('domain', 'No domain')}\n\n")
f.write(f"## Home Assistant Minimum Version\n{data['blueprint'].get('homeassistant', {}).get('min_version', 'No version specified')}\n\n")

f.write(f"## Inputs\n\n")

for section in ['required_entities', 'optional_entities']:
if section in data['blueprint']['input']:
f.write(f"### {data['blueprint']['input'][section].get('name', 'Unnamed Section')}\n")
f.write(f"{data['blueprint']['input'][section].get('description', 'No description')}\n\n")
for key, value in data['blueprint']['input'][section]['input'].items():
f.write(f"- **{value.get('name', 'Unnamed Input')}**\n")
f.write(f" - **Description**: {value.get('description', 'No description')}\n")
if 'default' in value:
f.write(f" - **Default**: {value['default']}\n")
if 'selector' in value:
f.write(f" - **Selector**: `{value['selector']}`\n")
f.write("\n")
try:
with open(markdown_file, 'w') as f:
f.write(f"# {data['blueprint'].get('name', 'Unnamed Blueprint')}\n\n")
f.write(f"## Description\n{data['blueprint'].get('description', 'No description')}\n\n")
f.write(f"## Source\n[{data['blueprint'].get('source_url', 'No source URL')}]({data['blueprint'].get('source_url', 'No source URL')})\n\n")
f.write(f"## Domain\n{data['blueprint'].get('domain', 'No domain')}\n\n")
f.write(f"## Home Assistant Minimum Version\n{data['blueprint'].get('homeassistant', {}).get('min_version', 'No version specified')}\n\n")

f.write(f"## Inputs\n\n")

for section in ['required_entities', 'optional_entities']:
if section in data['blueprint']['input']:
f.write(f"### {data['blueprint']['input'][section].get('name', 'Unnamed Section')}\n")
f.write(f"{data['blueprint']['input'][section].get('description', 'No description')}\n\n")
for key, value in data['blueprint']['input'][section]['input'].items():
f.write(f"- **{value.get('name', 'Unnamed Input')}**\n")
f.write(f" - **Description**: {value.get('description', 'No description')}\n")
if 'default' in value:
f.write(f" - **Default**: {value['default']}\n")
if 'selector' in value:
f.write(f" - **Selector**: `{value['selector']}`\n")
f.write("\n")

f.write("## Variables\n")
for key, value in data.get('variables', {}).items():
f.write(f"- `{key}`: {value}\n")
f.write("## Variables\n")
for key, value in data.get('variables', {}).items():
f.write(f"- `{key}`: {value}\n")

f.write("\n## Triggers\n")
for trigger in data.get('trigger', []):
trigger_id = trigger.get('id', 'Unknown')
platform = trigger.get('platform', 'Unknown')
from_state = trigger.get('from', 'Unknown')
to_state = trigger.get('to', 'Unknown')
f.write(f"- **{trigger_id}**: Triggered when the {platform} changes from `{from_state}` to `{to_state}`.\n")
f.write("\n## Triggers\n")
for trigger in data.get('trigger', []):
trigger_id = trigger.get('id', 'Unknown')
platform = trigger.get('platform', 'Unknown')
from_state = trigger.get('from', 'Unknown')
to_state = trigger.get('to', 'Unknown')
f.write(f"- **{trigger_id}**: Triggered when the {platform} changes from `{from_state}` to `{to_state}`.\n")

f.write("\n## Conditions\n")
for condition in data.get('condition', []):
f.write(f"- **{condition.get('condition', 'Unknown Condition')}**: {condition.get('value_template', 'No value template')}\n")
f.write("\n## Conditions\n")
for condition in data.get('condition', []):
f.write(f"- **{condition.get('condition', 'Unknown Condition')}**: {condition.get('value_template', 'No value template')}\n")

f.write("\n## Actions\n")
for action in data.get('action', []):
if 'choose' in action:
for choice in action['choose']:
conditions = choice.get('conditions', [])
if conditions:
condition_id = conditions[0].get('id', 'Unknown')
f.write(f"### {condition_id}\n")
for step in choice.get('sequence', []):
service = step.get('service', 'Unknown service')
data = step.get('data', 'No data')
f.write(f"- **{service}**: {data}\n")
else:
if 'service' in action:
service = action.get('service', 'Unknown service')
data = action.get('data', 'No data')
f.write(f"- **{service}**: {data}\n")
if 'delay' in action:
delay = action.get('delay', 'No delay specified')
f.write(f"- **Delay**: {delay}\n")
if 'wait_template' in action:
wait_template = action.get('wait_template', 'No wait template specified')
f.write(f"- **Wait Template**: {wait_template}\n")
f.write("\n## Actions\n")
for action in data.get('action', []):
if 'choose' in action:
for choice in action['choose']:
conditions = choice.get('conditions', [])
if conditions:
condition_id = conditions[0].get('id', 'Unknown')
f.write(f"### {condition_id}\n")
for step in choice.get('sequence', []):
service = step.get('service', 'Unknown service')
step_data = step.get('data', 'No data')
f.write(f"- **{service}**: {step_data}\n")
else:
if 'service' in action:
service = action.get('service', 'Unknown service')
action_data = action.get('data', 'No data')
f.write(f"- **{service}**: {action_data}\n")
if 'delay' in action:
delay = action.get('delay', 'No delay specified')
f.write(f"- **Delay**: {delay}\n")
if 'wait_template' in action:
wait_template = action.get('wait_template', 'No wait template specified')
f.write(f"- **Wait Template**: {wait_template}\n")

# Make mode optional
mode = data.get('mode', 'Not specified')
f.write(f"\n## Mode\n")
f.write(f"- **Mode**: {mode}\n")
# Make mode optional
mode = data.get('mode', 'Not specified')
f.write(f"\n## Mode\n")
f.write(f"- **Mode**: {mode}\n")

# Handle max_exceeded if present
max_exceeded = data.get('max_exceeded', 'Not specified')
f.write(f"- **Max Exceeded**: {max_exceeded}\n")
# Handle max_exceeded if present
max_exceeded = data.get('max_exceeded', 'Not specified')
f.write(f"- **Max Exceeded**: {max_exceeded}\n")
except Exception as exc:
print(f"Error writing to Markdown file {markdown_file}: {exc}")

if __name__ == "__main__":
yaml_file = sys.argv[1]
Expand Down

0 comments on commit 5a63e65

Please sign in to comment.