ruamel-yaml-line-info 0.1.2

Line information for ruamel.yaml.

ruamel_yaml_line_info

---

---

Line information for ruamel.yaml.

Quick Start

Using an Alternative Constructor

Instead of:

with open(yaml_path, encoding="utf-8") as fh:
    yaml = ruamel.yaml.YAML(typ="rt").load("".join(fh))

change the import:

with open(yaml_path, encoding="utf-8") as fh:
    yaml = ruamel_yaml_line_info.YAML(typ="rt").load("".join(fh))

and voila!

Patching an existing YAML object

If you already have a ruamel.yaml.YAML instance, you can add line numbers with:

with open(yaml_path, encoding="utf-8") as fh:
    yaml = ruamel.yaml.YAML(typ="rt").load("".join(fh))
    yaml = ruamel_yaml_line_info.YAML.with_line_numbers(yaml=yaml)

Recommended Installation

Install the Python package and dependency management tool poetry using official documentation. You must have Python 3.11 or greater available on your system path, which could be managed by mamba, pyenv, or another package manager. Finally, install the dependencies of the project with:

poetry install

To check successful installation, run:

python -c "import ruamel_yaml_line_info"

Installing into a Mamba Environment

Install the Python package and dependency management tool poetry and the environment manager mamba using official documentation. Create and activate a virtual environment with Python 3.11 or greater:

mamba create -n ruamel_yaml_line_info python=3.11
mamba activate ruamel_yaml_line_info

Then, because Poetry will auto-detect an activated environment, install the project with:

poetry install

To check successful installation, run:

python -c "import ruamel_yaml_line_info"

Development and Testing

See the contributing guide for more information.