mirror of https://github.com/yaml/pyyaml.git synced 2025-10-19 11:03:18 +00:00

Canonical source repository for PyYAML

python yaml

Find a file

Matt Davis 49790e7368 Release 6.0.3 (#889 ) * Update CI and Build Targets for Python 3.14 and Windows/arm64 (#864) * Update CI and Build Targets * Add Python 3.14 pre-release support * Add Windows/arm64 builds * Update to current GHA runner versions * Native aarch64 Linux runners * Fix musllinux 1.2 builds * musl libyaml build fixes * add 3.14t wheels w/ freethreading directive, misc CI/build cleanup * include package version in merged dist artifact filename (cherry picked from commit `d51d8a138f`) * Release 6.0.3		2025-09-25 14:10:45 -07:00
.github	Release 6.0.3 (#889 )	2025-09-25 14:10:45 -07:00
examples	Use full_load in yaml-highlight example (#359 )	2019-12-20 20:38:46 +01:00
lib	Release 6.0.3 (#889 )	2025-09-25 14:10:45 -07:00
packaging	Release 6.0.3 (#889 )	2025-09-25 14:10:45 -07:00
tests/legacy_tests	6.0.2rc1 (#809 )	2024-06-10 16:26:55 -07:00
yaml	Release 6.0.3 (#889 )	2025-09-25 14:10:45 -07:00
.gitignore	Move code from lib3 to lib	2021-09-22 15:52:05 +02:00
announcement.msg	6.0.1 release	2023-07-18 01:38:54 +02:00
CHANGES	Release 6.0.3 (#889 )	2025-09-25 14:10:45 -07:00
LICENSE	5.4 release	2021-01-19 14:07:59 -05:00
Makefile	Makefile tweaks	2021-09-23 14:42:00 -07:00
MANIFEST.in	6.0.2rc1 (#809 )	2024-06-10 16:26:55 -07:00
pyproject.toml	Release 6.0.3 (#889 )	2025-09-25 14:10:45 -07:00
README.md	6.0b1 release	2021-10-04 15:11:05 -04:00
setup.py	Release 6.0.3 (#889 )	2025-09-25 14:10:45 -07:00
tox.ini	Add python 3.11 support (#663 )	2022-09-13 15:12:45 -07:00

README.md

PyYAML

A full-featured YAML processing framework for Python

Installation

To install, type python setup.py install.

By default, the setup.py script checks whether LibYAML is installed and if so, builds and installs LibYAML bindings. To skip the check and force installation of LibYAML bindings, use the option --with-libyaml: python setup.py --with-libyaml install. To disable the check and skip building and installing LibYAML bindings, use --without-libyaml: python setup.py --without-libyaml install.

When LibYAML bindings are installed, you may use fast LibYAML-based parser and emitter as follows:

>>> yaml.load(stream, Loader=yaml.CLoader)
>>> yaml.dump(data, Dumper=yaml.CDumper)

If you don't trust the input YAML stream, you should use:

>>> yaml.safe_load(stream)

Testing

PyYAML includes a comprehensive test suite. To run the tests, type python setup.py test.

Further Information

For more information, check the PyYAML homepage.
PyYAML tutorial and reference.
Discuss PyYAML with the maintainers on Matrix at https://matrix.to/#/#pyyaml:yaml.io or IRC #pyyaml irc.libera.chat
Submit bug reports and feature requests to the PyYAML bug tracker.

License

The PyYAML module was written by Kirill Simonov xi@resolvent.net. It is currently maintained by the YAML and Python communities.

PyYAML is released under the MIT license.

See the file LICENSE for more details.