source: pyyaml/trunk/README @ 295

Revision 295, 1.2 KB checked in by xi, 6 years ago (diff)

Dropped tests from the source distribution since LibYAML bindings do not pass them; updated README and announcement.msg; renamed 'yaml.libyaml' to 'yaml.with_libyaml'.

Line 
1PyYAML - The next generation YAML parser and emitter for Python.
2
3To install, type 'python setup.py install'.
4
5By default, the setup.py script checks whether LibYAML is installed
6and if so, builds and installs LibYAML bindings.  To skip the check
7and force installation of LibYAML bindings, add the option '--with-libyaml':
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'.
11
12When LibYAML bindings are installed, you may use a fast LibYAML-based
13parser and emitter as follows:
14
15    >>> yaml.load(stream, Loader=yaml.CLoader)
16    >>> yaml.dump(data, Dumper=yaml.CDumper)
17
18For more information, check the PyYAML homepage:
19'http://pyyaml.org/wiki/PyYAML'.
20
21Documentation (rough and incomplete though):
22'http://pyyaml.org/wiki/PyYAMLDocumentation'.
23
24Post your questions and opinions to the YAML-Core mailing list:
25'http://lists.sourceforge.net/lists/listinfo/yaml-core'.
26
27Submit bug reports and feature requests to the PyYAML bug tracker:
28'http://pyyaml.org/newticket?component=pyyaml'.
29
30PyYAML is written by Kirill Simonov <xi@resolvent.net>.  It is released
31under the MIT license. See the file LICENSE for more details.
Note: See TracBrowser for help on using the repository browser.