Skip to content

Commit

Permalink
Updated the content of the README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
ingydotnet committed Sep 2, 2021
1 parent 99d27e7 commit 702b176
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,33 @@
# PyYAML - The next generation YAML parser and emitter for Python.
PyYAML
======

## Installing
A full-featured YAML processing framework for Python

## Installation

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`.
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:
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:
If you don't trust the input YAML stream, you should use:

>>> yaml.safe_load(stream)

## Testing

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

## Further Information

Expand All @@ -33,9 +36,7 @@ type `python setup.py test`.

- [PyYAML tutorial and reference](http://pyyaml.org/wiki/PyYAMLDocumentation).

- Discuss PyYAML with the maintainers in IRC #pyyaml irc.freenode.net or on
the [YAML-Core mailing list](
http://lists.sourceforge.net/lists/listinfo/yaml-core).
- Discuss PyYAML with the maintainers in IRC #pyyaml irc.freenode.net.

- Submit bug reports and feature requests to the
[PyYAML bug tracker](https://github.com/yaml/pyyaml/issues).
Expand All @@ -46,4 +47,5 @@ The PyYAML module was written by Kirill Simonov <[email protected]>.
It is currently maintained by the YAML and Python communities.

PyYAML is released under the MIT license.

See the file LICENSE for more details.

0 comments on commit 702b176

Please sign in to comment.