Metadata-Version: 2.1
Name: flaskerk
Version: 0.1.0
Summary: UNKNOWN
Home-page: https://github.com/kemingy/flaskerk
Author: Keming Yang
Author-email: kemingy94@gmail.com
License: UNKNOWN
Description: # Flaskerk
        
        Provide OpenAPI document and validation for flask service.
        
        Mainly built for Machine Learning Model services.
        
        ## Features
        
        - [x] JSON data(request&response) validation with pydantic
        - [x] Redoc UI
        - [x] OpenAPI spec
        - [ ] Swagger UI
        - [ ] support flask url path validation
        
        ## Quick Start
        
        ```py
        from typing import List
        from flask import Flask, request
        from flaskerk import Flaskerk
        from pydantic import BaseModel
        
        class Query(BaseModel):
            name: str
            uid: str
            limit: int = 5
        
        class Response(BaseModel):
            users: List[str]
        
        app = Flask(__name__)
        api = Flaskerk(app)
        
        @app.route('/api/recommend', methods=['POST'])
        @api.validate(query=Query, resp=Response)
        def recommend():
            # algorithm
            user = request.query
            print(user.name, user.uid)
            return Response(users=['xxx'] * user.limit)
        
        if __name__ == '__main__':
            app.run()
        ```
        
        try it with `http POST :5000/api/recommend name='hello' uid='uuuuu'`
        
        For more examples, check [examples](/examples).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
