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.

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

Format Readme using Markdown #519

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 0 additions & 43 deletions README

This file was deleted.

44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# PyYAML - 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`.

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)

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

>>> yaml.safe_load(stream)

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

## For more information

- Check the PyYAML homepage:
https://github.com/yaml/pyyaml.

- For PyYAML tutorial and reference, see:
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.

- Submit bug reports and feature requests to the PyYAML bug tracker:
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.

PyYAML is released under the MIT license.
See the file LICENSE for more details.