Metadata-Version: 2.1
Name: hepdata-converter-ws
Version: 0.2.0
Summary: Flask webservices enabling usage of hepdata-converter as a separate server over the network
Home-page: https://github.com/HEPData/hepdata-converter-ws
Author: HEPData Team
Author-email: info@hepdata.net
License: GPL
Download-URL: https://github.com/HEPData/hepdata-converter-ws/tarball/0.2.0
Description: [![Travis Status](https://www.travis-ci.org/HEPData/hepdata-converter-ws.svg?branch=master)](https://www.travis-ci.org/HEPData/hepdata-converter-ws)
        [![Coveralls Status](https://coveralls.io/repos/github/HEPData/hepdata-converter-ws/badge.svg?branch=master)](https://coveralls.io/github/HEPData/hepdata-converter-ws?branch=master)
        [![License](https://img.shields.io/github/license/HEPData/hepdata-converter-ws.svg)](https://github.com/HEPData/hepdata-converter-ws/blob/master/LICENSE.txt)
        [![GitHub Releases](https://img.shields.io/github/release/hepdata/hepdata-converter-ws.svg?maxAge=2592000)](https://github.com/HEPData/hepdata-converter-ws/releases)
        [![PyPI Version](https://img.shields.io/pypi/v/hepdata-converter-ws)](https://pypi.org/project/hepdata-converter-ws/)
        [![GitHub Issues](https://img.shields.io/github/issues/hepdata/hepdata-converter-ws.svg?maxAge=2592000)](https://github.com/HEPData/hepdata-converter-ws/issues)
        
        
        # hepdata-converter-ws
        
        Simple Flask Web Services wrapper in Python 3 for
        [hepdata-converter](https://github.com/HEPData/hepdata-converter).
        
        It allows running the
        [hepdata-converter](https://github.com/HEPData/hepdata-converter) as a
        web service on top of the [Flask](https://palletsprojects.com/p/flask/)
        micro web framework.
        
        ## API
        
        This web service provides one method which accepts `GET` JSON requests.
        The accepted format is as follows:
        
        ### Request
        
        ```
        [GET] /convert  (application/json)
        {
        input: Base64 encoded tar.gz file containing hepdata-converter-ws-data entry (directory / file)
        id: str used for caching purposes (same input files have to have same ID), not implemented?
        options: dictionary with options accepted by hepdata_converter.convert function. The most important are:
                 input_format: (input format identifier e.g. yaml, oldhepdata, etc.)
                 output_format: (output format identifier e.g. yaml, root, yoda, csv, etc.)
                 other options are dependent on the input / output format and are documented in their respective parsers / readers
                 in https://github.com/HEPData/hepdata-converter
        }
        ```
        
        ### Response
        
        The response has MIME type `application/x-gzip` and is a tar.gz file
        containing the hepdata-converter-ws-data directory with the
        requested file / files.
        
        
        ## API Usage
        
        It is recommended to use the
        [hepdata-converter-ws-client](https://github.com/HEPData/hepdata-converter-ws-client)
        library to interact with this web service, as it provides easier calling
        and more transparent usage.
Platform: UNKNOWN
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: tests
