Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert README to markdown #554

Closed
wants to merge 1 commit into from
Closed

Convert README to markdown #554

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 21 additions & 14 deletions README → README.md
View file
Open in desktop
@@ -1,40 +1,47 @@
PyYAML - The next generation YAML parser and emitter for Python.
PyYAML
======

To install, type 'python setup.py install'.
The next generation YAML parser and emitter for Python.

To install, type `python setup.py install`.

By default, the setup.py script checks whether LibYAML is installed
and if so, builds and installs LibYAML bindings. To skip the check
and force installation of LibYAML bindings, use the option '--with-libyaml':
'python setup.py --with-libyaml install'. To disable the check and
skip building and installing LibYAML bindings, use '--without-libyaml':
'python setup.py --without-libyaml install'.
and force installation of LibYAML bindings, use the option `--with-libyaml`:
`python setup.py --with-libyaml install`. To disable the check and
skip building and installing LibYAML bindings, use `--without-libyaml`:
`python setup.py --without-libyaml install`.

When LibYAML bindings are installed, you may use fast LibYAML-based
parser and emitter as follows:

>>> yaml.load(stream, Loader=yaml.CLoader)
>>> yaml.dump(data, Dumper=yaml.CDumper)
```python
>>> yaml.load(stream, Loader=yaml.CLoader)
>>> yaml.dump(data, Dumper=yaml.CDumper)
```

If you don't trust the input stream, you should use:

>>> yaml.safe_load(stream)
```python
>>> yaml.safe_load(stream)
```

PyYAML includes a comprehensive test suite. To run the tests,
type 'python setup.py test'.
type `python setup.py test`.

For more information, check the PyYAML homepage:
'https://github.com/yaml/pyyaml'.
<https://github.com/yaml/pyyaml>.

For PyYAML tutorial and reference, see:
'http://pyyaml.org/wiki/PyYAMLDocumentation'.
<http://pyyaml.org/wiki/PyYAMLDocumentation>.

Discuss PyYAML with the maintainers in IRC #pyyaml irc.freenode.net.

You may also use the YAML-Core mailing list:
'http://lists.sourceforge.net/lists/listinfo/yaml-core'.
<http://lists.sourceforge.net/lists/listinfo/yaml-core>.

Submit bug reports and feature requests to the PyYAML bug tracker:
'https://github.com/yaml/pyyaml/issues'.
<https://github.com/yaml/pyyaml/issues>.

The PyYAML module was written by Kirill Simonov <xi@resolvent.net>.
It is currently maintained by the YAML and Python communities.
Expand Down