Canonical source repository for PyYAML
Find a file
Matt Davis a2d19c0234
Conditional support for Cython3.x, CI updates (#808)
* Cython 3.x support needed for Python 3.13
* Move CI to a dynamic matrix
* Use GHA-hosted Apple Silicon runners
* Move Windows builds to cibuildwheel
* Implement rudimentary PEP517 config-settings passthru to setuptools with
  custom in-tree setuptools build backend shim (blocked Windows build
  being moved to cibuildwheel).
* Use build_config.toml to smuggle JSON to cibuildwheel, since it
  trashes JSON via CLI when doing containerized builds.
2024-06-10 15:24:15 -07:00
.github Conditional support for Cython3.x, CI updates (#808) 2024-06-10 15:24:15 -07:00
examples Use full_load in yaml-highlight example (#359) 2019-12-20 20:38:46 +01:00
lib 6.0.1 release 2023-08-28 15:29:27 -07:00
packaging Conditional support for Cython3.x, CI updates (#808) 2024-06-10 15:24:15 -07:00
tests Conditional support for Cython3.x, CI updates (#808) 2024-06-10 15:24:15 -07:00
yaml Remove Python 2 support and simplify 2021-09-23 14:42:00 -07:00
.gitignore Move tests to pytest 2023-11-10 11:37:15 -08:00
announcement.msg 6.0.1 release 2023-08-28 15:29:27 -07:00
CHANGES 6.0.1 release 2023-08-28 15:29:27 -07:00
LICENSE 5.4 release 2021-01-19 14:07:59 -05:00
Makefile Move tests to pytest 2023-11-10 11:37:15 -08:00
MANIFEST.in Conditional support for Cython3.x, CI updates (#808) 2024-06-10 15:24:15 -07:00
pyproject.toml Conditional support for Cython3.x, CI updates (#808) 2024-06-10 15:24:15 -07:00
README.md 6.0b1 release 2021-10-04 15:11:05 -04:00
setup.py Conditional support for Cython3.x, CI updates (#808) 2024-06-10 15:24:15 -07:00
tox.ini Move tests to pytest 2023-11-10 11:37:15 -08:00

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

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.