gbianka / api_sheet Goto Github PK

This project aims to provide endpoints for the extraction of basic data from an Excel file (.xlsx) and, also, a simple image conversion route.

• Python 3.7.2
• Flask 1.1.2

• Cross Origin Resource Sharing (CORS)

pip install -U flask-cors

• pyjwt

pip install pyjwt

• openpyxl

pip install openpyxl

• Pyllow

pip install --upgrade Pillow

• Install the requirements
• Install and create a virtualenv

pip install virtualenv

• Install the extra libraries
• clone the reposotory

git clone https://github.com/JailsonS/api_sheetgo

-> controllers [ it contains the controllers with the routes to perform conversion ]
-------> excelcontroller.py [ it contains the route and methods to read an excel file ]
-------> imagecontroller.py [ it contains the route and methods to read and convert an image file ]
-> models
-------> auth.py [ it contains information and methods to authenticate data ]
-> sample
-------> sample.xlsx [ it contains a simple xlsx file with some information. It can be used to test the routes ]

A very simple way to test the API is using the website https://resttesttest.com/. The endpoints that will be tested are:

• [YOUR_BASE_DIR]/excel/info
• [YOUR_BASE_DIR]/image/convert

• Activate the virtualenv and go to the project's directory
• run the code below:

flask run

Go to https://resttesttest.com/, set the POST method and input PARAMETERS

• email credentials, the parameter name must be "email" and the parameter value is one of the credentialed emails sent
• .xlsx file the parameter name must be "sample_file" and the parameter value is the sample file in the Sample folder

• json with some info: res_tab (tabs of the file ordered alphabetically), res (value of the first tab), jwt_token (JWT token encoded, the [b'] is not part of JWT!) If you want to check the JWT decoded go to https://jwt.io/#debugger-io and past only the JWT token response, mark "secret base64 encoded"

• convert_type (PNG or JPEG), the parameter name must be "convert_type"
• image file, the parameter name must be "input_img"

• format - image format output
• size - image size
• mode - RGB
• PIL_obj - Pillow Object
• the converted image can be found in your root virtualenv dir