Skip to content
Back to top
View this page

# Welcome to annotatedyaml documentation!

Installation & Usage

- Installation
- Usage

Project Info

- Changelog
  - v1.0.2 (2025-10-04)
  - v1.0.1 (2025-10-04)
  - v1.0.0 (2025-08-01)
  - v0.4.5 (2025-03-22)
  - v0.4.4 (2025-03-19)
  - v0.4.3 (2025-03-18)
  - v0.4.2 (2025-03-18)
  - v0.4.1 (2025-03-18)
  - v0.4.0 (2025-03-18)
  - v0.3.0 (2025-03-18)
  - v0.2.0 (2025-03-16)
  - v0.1.1 (2025-02-21)
  - v0.1.0 (2025-02-21)
- Contributing
  - Types of Contributions
  - Get Started!
  - Pull Request Guidelines
  - Tips
  - Making a new release

API Reference

- annotatedyaml package
  - `Input`
  - `NodeDictClass`
  - `NodeListClass`
  - `NodeStrClass`
  - `Secrets`
  - `UndefinedSubstitution`
  - `YAMLException`
  - `YamlTypeError`
  - `dump()`
  - `extract_inputs()`
  - `load_yaml()`
  - `load_yaml_dict()`
  - `parse_yaml()`
  - `save_yaml()`
  - `secret_yaml()`
  - `substitute()`
  - Submodules
  - annotatedyaml.const module
  - annotatedyaml.constructors module
  - annotatedyaml.dumper module
  - annotatedyaml.exceptions module
  - annotatedyaml.input module
  - annotatedyaml.loader module
  - annotatedyaml.objects module
  - annotatedyaml.reference module
  - annotatedyaml.reference_object module

# annotatedyaml

Documentation: https://annotatedyaml.readthedocs.io

Source Code: https://github.com/home-assistant-libs/annotatedyaml

Annotated YAML that supports secrets for Python

## Installation

Install this via pip (or your favourite package manager):

`pip install annotatedyaml`

## Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

## Credits

This package was created with Copier and the browniebroke/pypackage-template project template.