https://github.com/yaml/pyyaml

Canonical source repository for PyYAML
https://github.com/yaml/pyyaml

python yaml

Last synced: 3 days ago
JSON representation

Canonical source repository for PyYAML

• Host: GitHub
• URL: https://github.com/yaml/pyyaml
• Owner: yaml
• License: mit
• Created: 2011-11-03T05:09:49.000Z (about 13 years ago)
• Default Branch: main
• Last Pushed: 2024-08-19T12:33:19.000Z (4 months ago)
• Last Synced: 2024-12-02T12:03:56.700Z (10 days ago)
• Topics: python, yaml
• Language: Python
• Homepage:
• Size: 818 KB
• Stars: 2,581
• Watchers: 54
• Forks: 517
• Open Issues: 288
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES
  • License: LICENSE
  • Security: .github/SECURITY.md

Awesome Lists containing this project

• best-of-python - GitHub - 46% open · ⏱️ 14.11.2023): (File Formats)
• awesome-starred - pyyaml - Canonical source repository for PyYAML (Python)
• awesome-list - PyYAML - Canonical source repository for PyYAML. (Data Format & I/O / For Python)
• awesome-python - PyYAML - A YAML parser and emitter for Python. (Libraries / Core Libraries)
• awesome-python - PyYAML - A YAML parser and emitter for Python. (Libraries / Core Libraries)

README

        
PyYAML

======

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`.

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 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`.

## Further Information

* For more information, check the

  [PyYAML homepage](https://github.com/yaml/pyyaml).

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

* Discuss PyYAML with the maintainers on

  Matrix at https://matrix.to/#/#pyyaml:yaml.io or

  IRC #pyyaml irc.libera.chat

* Submit bug reports and feature requests to the

  [PyYAML bug tracker](https://github.com/yaml/pyyaml/issues).

## License

The PyYAML module was written by Kirill Simonov .

It is currently maintained by the YAML and Python communities.

PyYAML is released under the MIT license.

See the file LICENSE for more details.