tree: 0c1508c4d104d03b9a2568e5a3481562988a1ded [path history] [tgz]
  1. .github/
  2. examples/
  3. lib/
  4. packaging/
  5. tests/
  6. yaml/
  7. .gitignore
  8. Android.bp
  9. announcement.msg
  10. CHANGES
  11. LICENSE
  12. Makefile
  13. MANIFEST.in
  14. METADATA
  15. MODULE_LICENSE_MIT
  16. NOTICE
  17. OWNERS
  18. pyproject.toml
  19. README.md
  20. setup.py
  21. tox.ini
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

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.