README.md
1PyYAML
2======
3
4A full-featured YAML processing framework for Python
5
6## Installation
7
8To install, type `python setup.py install`.
9
10By default, the `setup.py` script checks whether LibYAML is installed and if
11so, builds and installs LibYAML bindings.
12To skip the check and force installation of LibYAML bindings, use the option
13`--with-libyaml`: `python setup.py --with-libyaml install`.
14To disable the check and skip building and installing LibYAML bindings, use
15`--without-libyaml`: `python setup.py --without-libyaml install`.
16
17When LibYAML bindings are installed, you may use fast LibYAML-based parser and
18emitter as follows:
19
20 >>> yaml.load(stream, Loader=yaml.CLoader)
21 >>> yaml.dump(data, Dumper=yaml.CDumper)
22
23If you don't trust the input YAML stream, you should use:
24
25 >>> yaml.safe_load(stream)
26
27## Testing
28
29PyYAML includes a comprehensive test suite.
30To run the tests, type `python setup.py test`.
31
32## Further Information
33
34* For more information, check the
35 [PyYAML homepage](https://github.com/yaml/pyyaml).
36
37* [PyYAML tutorial and reference](http://pyyaml.org/wiki/PyYAMLDocumentation).
38
39* Discuss PyYAML with the maintainers on
40 Matrix at https://matrix.to/#/#pyyaml:yaml.io or
41 IRC #pyyaml irc.libera.chat
42
43* Submit bug reports and feature requests to the
44 [PyYAML bug tracker](https://github.com/yaml/pyyaml/issues).
45
46## License
47
48The PyYAML module was written by Kirill Simonov <[email protected]>.
49It is currently maintained by the YAML and Python communities.
50
51PyYAML is released under the MIT license.
52
53See the file LICENSE for more details.
54