source: pyyaml/trunk/README @ 336

Revision 336, 1.3 KB checked in by xi, 6 years ago (diff)

Final touches before the release.

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