Pablo Santiago Blum de Aguiar | 2c225b2 | 2015-04-04 13:25:24 -0300 | [diff] [blame] | 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 | |
sblondon | 6549385 | 2019-12-07 22:44:29 +0100 | [diff] [blame] | 18 | If you don't trust the input stream, you should use: |
| 19 | |
| 20 | >>> yaml.safe_load(stream) |
| 21 | |
Pablo Santiago Blum de Aguiar | 2c225b2 | 2015-04-04 13:25:24 -0300 | [diff] [blame] | 22 | PyYAML includes a comprehensive test suite. To run the tests, |
| 23 | type 'python setup.py test'. |
| 24 | |
| 25 | For more information, check the PyYAML homepage: |
Ingy döt Net | 4c2e993 | 2018-06-24 17:08:57 -0600 | [diff] [blame] | 26 | 'https://github.com/yaml/pyyaml'. |
Pablo Santiago Blum de Aguiar | 2c225b2 | 2015-04-04 13:25:24 -0300 | [diff] [blame] | 27 | |
| 28 | For PyYAML tutorial and reference, see: |
| 29 | 'http://pyyaml.org/wiki/PyYAMLDocumentation'. |
| 30 | |
Alex Gaynor | d3eb7da | 2018-06-24 23:56:07 -0400 | [diff] [blame] | 31 | Discuss PyYAML with the maintainers in IRC #pyyaml irc.freenode.net. |
| 32 | |
| 33 | You may also use the YAML-Core mailing list: |
Pablo Santiago Blum de Aguiar | 2c225b2 | 2015-04-04 13:25:24 -0300 | [diff] [blame] | 34 | 'http://lists.sourceforge.net/lists/listinfo/yaml-core'. |
| 35 | |
| 36 | Submit bug reports and feature requests to the PyYAML bug tracker: |
psanchez | 2c55eb6 | 2017-03-28 09:41:10 -0500 | [diff] [blame] | 37 | 'https://github.com/yaml/pyyaml/issues'. |
Pablo Santiago Blum de Aguiar | 2c225b2 | 2015-04-04 13:25:24 -0300 | [diff] [blame] | 38 | |
Alex Gaynor | d3eb7da | 2018-06-24 23:56:07 -0400 | [diff] [blame] | 39 | The PyYAML module was written by Kirill Simonov <xi@resolvent.net>. |
| 40 | It is currently maintained by the YAML and Python communities. |
| 41 | |
| 42 | PyYAML is released under the MIT license. |
| 43 | See the file LICENSE for more details. |