Welcome to pureyaml’s documentation!

Contents:

pureyaml

Latest Version Development Status Build Status Coverage Status Documentation Status

Yet another yaml parser, in pure python.

Features

Credits

Tools used in rendering this package:

Installation

At the command line either via easy_install or pip:

$ pip install pureyaml

$ easy_install pureyaml

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv pureyaml
$ pip install pureyaml

Uninstall:

$ pip uninstall pureyaml

Usage

To use pureyaml in a project:

import pureyaml

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/bionikspoon/pureyaml/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

pureyaml could always use more documentation, whether as part of the official pureyaml docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/bionikspoon/pureyaml/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up pureyaml for local development.

  1. Fork the pureyaml repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/pureyaml.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv pureyaml
$ cd pureyaml/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b feature/name-of-your-feature
$ git checkout -b hotfix/name-of-your-bugfix

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 pureyaml tests
$ python setup.py test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4, 3.5, and PyPy. Check https://travis-ci.org/bionikspoon/pureyaml/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests/test_pureyaml.py

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

Next Release

  • Coming Soon

0.1.0 (2015-12-13)

  • First release on PyPI.

Feedback

If you have any suggestions or questions about pureyaml feel free to email me at bionikspoon@gmail.com.

If you encounter any errors or problems with pureyaml, please let me know! Open an Issue at the GitHub https://github.com/bionikspoon/pureyaml main repository.

Indices and tables