https://github.com/hugapi/hug_yaml

A hug extension that adds YAML output_format, input_format, and documentation support to hug.
https://github.com/hugapi/hug_yaml

Last synced: 8 months ago
JSON representation

A hug extension that adds YAML output_format, input_format, and documentation support to hug.

• Host: GitHub
• URL: https://github.com/hugapi/hug_yaml
• Owner: hugapi
• License: mit
• Created: 2016-04-12T04:40:45.000Z (almost 10 years ago)
• Default Branch: develop
• Last Pushed: 2022-12-26T20:28:34.000Z (about 3 years ago)
• Last Synced: 2025-06-17T13:17:56.064Z (9 months ago)
• Language: Python
• Size: 555 KB
• Stars: 5
• Watchers: 7
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
hug_yaml

===================

[![PyPI version](https://badge.fury.io/py/hug_yaml.svg)](http://badge.fury.io/py/hug_yaml)

[![Build Status](https://travis-ci.org/timothycrosley/hug_yaml.svg?branch=master)](https://travis-ci.org/timothycrosley/hug_yaml)

[![Coverage Status](https://coveralls.io/repos/timothycrosley/hug_yaml/badge.svg?branch=master&service=github)](https://coveralls.io/github/timothycrosley/hug_yaml?branch=master)

[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://pypi.python.org/pypi/hug_yaml/)

[![Join the chat at https://gitter.im/timothycrosley/hug](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/timothycrosley/hug?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

An extension for hug that provides YAML input formats, output formats, and documentation:

```py

import hug

import hug_yaml

hug.API(__name__).extend(hug_yaml.input_format)

@hug.not_found(output=hug_yaml.output)

def documentation(hug_api, hug_api_version):

    return hug_api.http.documentation(hug_api, hug_api_version)

```

Installing hug_yaml

===================

Installing hug_yaml is as simple as:

```bash

pip3 install hug_yaml --upgrade

```

Ideally, within a virtual environment.

Why hug_yaml?

===================

An extension for hug that provides YAML input formats, output formats, and documentation.

--------------------------------------------

Thanks and I hope you find hug_yaml helpful!

~Timothy Crosley