blob: 49c87e7642368567511df9ce63fccfa8aee64035 [file] [log] [blame]
Pablo Santiago Blum de Aguiar2c225b22015-04-04 13:25:24 -03001PyYAML - 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, use 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 fast LibYAML-based
13parser and emitter as follows:
14
15 >>> yaml.load(stream, Loader=yaml.CLoader)
16 >>> yaml.dump(data, Dumper=yaml.CDumper)
17
sblondon65493852019-12-07 22:44:29 +010018If you don't trust the input stream, you should use:
19
20 >>> yaml.safe_load(stream)
21
Pablo Santiago Blum de Aguiar2c225b22015-04-04 13:25:24 -030022PyYAML includes a comprehensive test suite. To run the tests,
23type 'python setup.py test'.
24
25For more information, check the PyYAML homepage:
Ingy döt Net4c2e9932018-06-24 17:08:57 -060026'https://github.com/yaml/pyyaml'.
Pablo Santiago Blum de Aguiar2c225b22015-04-04 13:25:24 -030027
28For PyYAML tutorial and reference, see:
29'http://pyyaml.org/wiki/PyYAMLDocumentation'.
30
Alex Gaynord3eb7da2018-06-24 23:56:07 -040031Discuss PyYAML with the maintainers in IRC #pyyaml irc.freenode.net.
32
33You may also use the YAML-Core mailing list:
Pablo Santiago Blum de Aguiar2c225b22015-04-04 13:25:24 -030034'http://lists.sourceforge.net/lists/listinfo/yaml-core'.
35
36Submit bug reports and feature requests to the PyYAML bug tracker:
psanchez2c55eb62017-03-28 09:41:10 -050037'https://github.com/yaml/pyyaml/issues'.
Pablo Santiago Blum de Aguiar2c225b22015-04-04 13:25:24 -030038
Alex Gaynord3eb7da2018-06-24 23:56:07 -040039The PyYAML module was written by Kirill Simonov <xi@resolvent.net>.
40It is currently maintained by the YAML and Python communities.
41
42PyYAML is released under the MIT license.
43See the file LICENSE for more details.