| commit | 99d27e78e87838e96c4a859d3fb87e9d36407811 | [log] [tgz] |
|---|---|---|
| author | Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> | Mon Aug 05 12:20:59 2019 +0200 |
| committer | Ingy döt Net <ingy@ingy.net> | Thu Sep 02 09:23:19 2021 -0700 |
| tree | 3064a608d025cf6c4965d5f46f76ceba16d9da79 | |
| parent | ee37f4653c08fc07aecff69cfd92848e6b1a540e [diff] |
Change README format to Markdown
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 stream, you should use:
>>> yaml.safe_load(stream)
PyYAML includes a comprehensive test suite. To run the tests, type python setup.py test.
For more information, check the PyYAML homepage.
Discuss PyYAML with the maintainers in IRC #pyyaml irc.freenode.net or on the YAML-Core mailing list.
Submit bug reports and feature requests to the PyYAML bug tracker.
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.