-
Notifications
You must be signed in to change notification settings - Fork 525
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated the content of the README.md file
- Loading branch information
1 parent
99d27e7
commit 702b176
Showing
1 changed file
with
18 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
|
@@ -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). | ||
|
@@ -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. |