clippie 0.0.1

A small application to see product data

online-retail-app

This is a FastAPI application that accepts a product description as input and returns the top 10 most similar products that are in the transaction data. The dataset used in this application is located at the following URL

Install

pip install clippie

Install the application from the local directory

pip install -e .

Run

Run the application with the following command

clippie

or

python3 src/clippie/main.py

Upon start the application loads sample dataset that is located in data folder

API endpoints

Available endpoints:

• /docs - GET - API documentation
• /product - GET - displays list of products
• /product?search=coala - GET - find relevant products to the provided desciption
• /pipeline - POST

TODO

• deploy to pypi
• package Java jar file in order to open excel with pyspark
• enable tempfile
• GET pipeline to see the number of pipeline that has been executed
• add history of pipeline execution to GET pipeline
• what will happen if pipelines run in parallel?
• Github action
• Stop Spark on program termination
• BUG - spark is loaded twice!
• add debug mode
• run the application
• precalculate number of words in entire dataset
• what if I pass a new word to product GET?
• product should be more than 0.0
• BUG - product search stopped working