Imported Upstream version 3.10
[platform/upstream/python-PyYAML.git] / README
1 PyYAML - The next generation YAML parser and emitter for Python.
2
3 To install, type 'python setup.py install'.
4
5 By default, the setup.py script checks whether LibYAML is installed
6 and if so, builds and installs LibYAML bindings.  To skip the check
7 and force installation of LibYAML bindings, use the option '--with-libyaml':
8 'python setup.py --with-libyaml install'.  To disable the check and
9 skip building and installing LibYAML bindings, use '--without-libyaml':
10 'python setup.py --without-libyaml install'.
11
12 When LibYAML bindings are installed, you may use fast LibYAML-based
13 parser and emitter as follows:
14
15     >>> yaml.load(stream, Loader=yaml.CLoader)
16     >>> yaml.dump(data, Dumper=yaml.CDumper)
17
18 PyYAML includes a comprehensive test suite.  To run the tests,
19 type 'python setup.py test'.
20
21 For more information, check the PyYAML homepage:
22 'http://pyyaml.org/wiki/PyYAML'.
23
24 For PyYAML tutorial and reference, see:
25 'http://pyyaml.org/wiki/PyYAMLDocumentation'.
26
27 Post your questions and opinions to the YAML-Core mailing list:
28 'http://lists.sourceforge.net/lists/listinfo/yaml-core'.
29
30 Submit bug reports and feature requests to the PyYAML bug tracker:
31 'http://pyyaml.org/newticket?component=pyyaml'.
32
33 PyYAML is written by Kirill Simonov <xi@resolvent.net>.  It is released
34 under the MIT license. See the file LICENSE for more details.
35