Metadata-Version: 1.1
Name: pyhttpstatus-utils
Version: 0.2.1
Summary: Extension of Python Standard Library http.HTTPStatus providing addtional utilities.
Home-page: https://github.com/TuneLab/pyhttpstatus-utils
Author: TUNE Inc., TuneLab
Author-email: jefft@tune.com
License: MIT License
Download-URL: https://github.com/TuneLab/pyhttpstatus-utils/archive/v0.2.1.tar.gz
Description-Content-Type: UNKNOWN
Description: .. -*- mode: rst -*-
        
        pyhttpstatus-utils
        ------------------
        
        Extension of Python Standard Library's `http.HTTPStatus <https://docs.python.org/3/library/http.html>`_ providing mapping of HTTP statuses.
        
        Badges
        ------
        
        .. start-badges
        
        .. list-table::
            :stub-columns: 1
        
            * - docs
              - |docs| |license|
            * - info
              - |hits| |contributors|
            * - tests
              - |travis| |coveralls|
            * - package
              - |version| |supported-versions|
            * - other
              - |requires|
        
        .. |docs| image:: https://readthedocs.org/projects/pyhttpstatus-utils/badge/?style=flat
            :alt: Documentation Status
            :target: http://pyhttpstatus-utils.readthedocs.io
        
        .. |hits| image:: http://hits.dwyl.io/TuneLab/pyhttpstatus-utils.svg
            :alt: Hit Count
            :target: http://hits.dwyl.io/TuneLab/pyhttpstatus-utils
        
        .. |contributors| image:: https://img.shields.io/github/contributors/TuneLab/pyhttpstatus-utils.svg
            :alt: Contributors
            :target: https://github.com/TuneLab/pyhttpstatus-utils/graphs/contributors
        
        .. |license| image:: https://img.shields.io/badge/License-MIT-yellow.svg
            :alt: License Status
            :target: https://opensource.org/licenses/MIT
        
        .. |travis| image:: https://travis-ci.org/TuneLab/pyhttpstatus-utils.svg?branch=master
            :alt: Travis-CI Build Status
            :target: https://travis-ci.org/TuneLab/pyhttpstatus-utils
        
        .. |coveralls| image:: https://coveralls.io/repos/TuneLab/pyhttpstatus-utils/badge.svg?branch=master&service=github
            :alt: Code Coverage Status
            :target: https://coveralls.io/r/TuneLab/pyhttpstatus-utils
        
        .. |version| image:: https://img.shields.io/pypi/v/pyhttpstatus-utils.svg?style=flat
            :alt: PyPI Package latest release
            :target: https://pypi.python.org/pypi/pyhttpstatus-utils
        
        .. |supported-versions| image:: https://img.shields.io/pypi/pyversions/pyhttpstatus-utils.svg?style=flat
            :alt: Supported versions
            :target: https://pypi.python.org/pypi/pyhttpstatus-utils
        
        .. |requires| image:: https://requires.io/github/TuneLab/pyhttpstatus-utils/requirements.svg?branch=master
            :alt: Requirements Status
            :target: https://requires.io/github/TuneLab/pyhttpstatus-utils/requirements/?branch=master
        
        .. end-badges
        
        
        Install
        -------
        
        .. code-block:: bash
        
            pip install pyhttpstatus-utils
        
        Functions
        ---------
        
        - ``http_status_dict(override_dict=None)``: HTTP Status Dictionary with Overrides if provided.
        - ``http_status_code_to_desc(http_status_code)``: Get HTTP status code description.
        - ``http_status_code_to_type(http_status_code)``: Get HTTP Status Code Type.
        - ``is_http_status_type(http_status_code)``: Match if provided HTTP Status Code is expected HTTP Status Code Type.
        - ``is_http_status_successful(http_status_code)``: Check if HTTP Status Code is type Successful
        - ``validate_http_code(http_code, minimum=100, maximum=599, strict=True, default_http_code=0)``: Validate HTTP code. If strict, throw, else just return default_http_code.
        
        
        HTTP Status Code Types
        ^^^^^^^^^^^^^^^^^^^^^^
        
        - 100: HttpStatusType.INFORMATIONAL,
        - 200: HttpStatusType.SUCCESSFUL,
        - 300: HttpStatusType.REDIRECTION,
        - 400: HttpStatusType.CLIENT_ERROR,
        - 500: HttpStatusType.SERVER_ERROR
        
        
        Requirements
        ------------
        
        ``pyhttpstatus-utils`` module is built upon Python 3 and has dependencies upon
        several Python modules available within `Python Package Index PyPI <https://pypi.python.org/pypi>`_.
        
        .. code-block:: bash
        
            make install-requirements
        
        or
        
        
        .. code-block:: bash
        
            python3 -m pip uninstall --yes --no-input -r requirements.txt
            python3 -m pip install --upgrade -r requirements.txt
        
        
        Dependencies
        ^^^^^^^^^^^^
        
        - `wheel <https://pypi.python.org/pypi/wheel>`_
        
        
        .. :changelog:
        
        Release History
        ===============
        
        
        0.3.0 (2017-12-10)
        ------------------
        - readthedocs.org
        
        0.2.0 (2017-12-05)
        ------------------
        - README.rst
        - Tests
        - Travis CI
        
        0.1.1 (2016-11-22)
        ------------------
        - Makefile and yapf cleanup
        
        0.1.0 (2016-11-17)
        ------------------
        - Initial Code
        - Code pulled from TuneLab/tune-mv-integration-python
        
        0.0.1 (2016-11-17)
        ------------------
        - Initial commit
        
Keywords: http httpstatus utilities tune multiverse
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: PyPy
