Metadata-Version: 2.1
Name: Flask-ResponseBuilder
Version: 1.1.0
Summary: Implementations of flask response in many formats
Home-page: https://github.com/cs91chris/flask_response_builder
Author: cs91chris
Author-email: cs91chris@voidbrain.me
License: MIT
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: Flask (==1.0.2)
Requires-Dist: PyYAML (==5.1)
Requires-Dist: xmltodict (==0.12.0)
Requires-Dist: dicttoxml (==1.7.4)

Flask-ResponseBuilder
=====================

Implementations of flask response in many formats: base64, csv, json, xml, html, yaml.

Based on PyYAML, xmltodict, dicttoxml. See their documentation for other options.

- Decorator for http response status 201 CREATED
- Decorator for http response status 204 NO_CONTENT
- Response based on Accept header of request
- Response based on format parameter (query string)
- template_or_json: response based on xhr request
- Support for case notation checker and converter. See ``Case`` class

Quickstart
~~~~~~~~~~

Install ``flask_response_builder`` using ``pip``:

::

   $ pip install Flask-ResponseBuilder

.. _section-1:

Example usage
^^^^^^^^^^^^^

For example usage see ``test.py`` file in example folder.

.. _section-2:

Configuration
^^^^^^^^^^^^^

    1.  ``RB_DEFAULT_ENCODE``: *(default: utf-8)*
    2.  ``RB_DEFAULT_DUMP_INDENT``: *(default: None)*
    3.  ``RB_BASE64_ALTCHARS``: *(default: None)*
    4.  ``RB_BASE64_CONTENT_TYPE``: *(default: text/plain)*
    5.  ``RB_HTML_DEFAULT_TEMPLATE``: *(default: None)*
    6.  ``RB_YAML_ALLOW_UNICODE``: *(default: True)*
    7.  ``RB_CSV_DEFAULT_NAME``: *(default: filename)*
    8.  ``RB_CSV_QUOTING``: *(default: False)*
    9.  ``RB_CSV_DELIMITER``: *(default: ;)*
    10. ``RB_CSV_QUOTING_CHAR``: *(default: ")*
    11. ``RB_CSV_DIALECT``: *(default: excel-tab)*
    12. ``RB_XML_CDATA``: *(default: False)*
    13. ``RB_XML_ROOT``: *(default: root)*
    14. ``RB_DEFAULT_RESPONSE_FORMAT``: *(default: application/json)*


License MIT


